# HG changeset patch # User Michael Hope # Date 1321391181 -46800 # Node ID 6c5658b8b5882a83a7376b8e25540360ddea634b # Parent 986e90e1ca273af2415fd181e4ec32643cd0e476 scripts: add support for building manuals Add support for building the HTML and PDF manuals for the major components. Implement for binutils, GCC, GDB, and GLIBC. Always build all manuals and install a subset. Be explicit about the subset to reduce the clutter and to avoid getting copies of common manuals like bfd from all of the sourceware based components. Downside of being explicit is that you need to update it when a new component comes along. Build the manuals as part of the last GCC build, namely 'cc' for glibc based ones and cc_core_pass_2 for baremetal. An example of the output is at: http://people.linaro.org/~michaelh/incoming/crosstool-NG/ Signed-off-by: Michael Hope [yann.morin.1998@anciens.enib.fr: depends on ! remove docs; gold manual install] Signed-off-by: "Yann E. MORIN" diff -r 986e90e1ca27 -r 6c5658b8b588 config/global/paths.in --- a/config/global/paths.in Wed Nov 16 17:36:17 2011 -0500 +++ b/config/global/paths.in Wed Nov 16 10:06:21 2011 +1300 @@ -90,6 +90,14 @@ Remove the installed documentation (man and info pages). Gains around 8MiB for a uClibc-based, C and C++ compiler. +config BUILD_MANUALS + bool + prompt "Build the manuals" + depends on ! REMOVE_DOCS + help + Build the PDF and HTML manuals for the main components such as + binutils, GCC, GDB, and the C library. + config INSTALL_DIR_RO bool prompt "Render the toolchain read-only" diff -r 986e90e1ca27 -r 6c5658b8b588 scripts/build/binutils/binutils.sh --- a/scripts/build/binutils/binutils.sh Wed Nov 16 17:36:17 2011 -0500 +++ b/scripts/build/binutils/binutils.sh Wed Nov 16 10:06:21 2011 +1300 @@ -20,6 +20,8 @@ local -a extra_config local -a extra_make_flags local -a binutils_tools + local -a manuals_for + local -a manuals_install mkdir -p "${CT_BUILD_DIR}/build-binutils" cd "${CT_BUILD_DIR}/build-binutils" @@ -90,6 +92,18 @@ CT_DoLog EXTRA "Installing binutils" CT_DoExecLog ALL make install + if [ "${CT_BUILD_MANUALS}" = "y" ]; then + CT_DoLog EXTRA "Building and installing the binutils manuals" + manuals_for=( gas binutils ld gprof ) + if [ "${CT_BINUTILS_LINKER_GOLD}" = "y" ]; then + manuals_for+=( gold ) + fi + manuals_install=( "${manuals_for[@]/#/install-pdf-}" ) + manuals_install+=( "${manuals_for[@]/#/install-html-}" ) + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + CT_DoExecLog ALL make "${manuals_install[@]}" + fi + # Install the wrapper if needed if [ "${CT_BINUTILS_LD_WRAPPER}" = "y" ]; then CT_DoLog EXTRA "Installing ld wrapper" diff -r 986e90e1ca27 -r 6c5658b8b588 scripts/build/cc/gcc.sh --- a/scripts/build/cc/gcc.sh Wed Nov 16 17:36:17 2011 -0500 +++ b/scripts/build/cc/gcc.sh Wed Nov 16 10:06:21 2011 +1300 @@ -79,9 +79,9 @@ case "${CT_BARE_METAL},${CT_CANADIAN},${CT_THREADS}" in y,*,*) if [ "${CT_STATIC_TOOLCHAIN}" = "y" ]; then - do_cc_core mode=baremetal build_libgcc=yes build_libstdcxx=yes build_staticlinked=yes + do_cc_core mode=baremetal build_libgcc=yes build_libstdcxx=yes build_staticlinked=yes build_manuals=yes else - do_cc_core mode=baremetal build_libgcc=yes build_libstdcxx=yes + do_cc_core mode=baremetal build_libgcc=yes build_libstdcxx=yes build_manuals=yes fi ;; ,y,*) ;; @@ -114,6 +114,7 @@ local build_libgcc=no local build_libstdcxx=no local build_staticlinked=no + local build_manuals=no local core_prefix_dir local lang_opt local tmp @@ -381,6 +382,13 @@ CT_DoLog EXTRA "Installing ${mode} core C compiler" CT_DoExecLog ALL make ${JOBSFLAGS} "${core_targets[@]/#/install-}" + if [ "${CT_BUILD_MANUALS}" = "y" -a "${build_manuals}" = "yes" ]; then + CT_DoLog EXTRA "Building the GCC manuals" + CT_DoExecLog ALL make pdf html + CT_DoLog EXTRA "Installing the GCC manuals" + CT_DoExecLog ALL make install-{pdf,html}-gcc + fi + # Create a symlink ${CT_TARGET}-cc to ${CT_TARGET}-gcc to always be able # to call the C compiler with the same, somewhat canonical name. # check whether compiler has an extension @@ -625,6 +633,13 @@ CT_DoLog EXTRA "Installing final compiler" CT_DoExecLog ALL make ${JOBSFLAGS} install + if [ "${CT_BUILD_MANUALS}" = "y" ]; then + CT_DoLog EXTRA "Building the GCC manuals" + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + CT_DoLog EXTRA "Installing the GCC manuals" + CT_DoExecLog ALL make install-{pdf,html}-gcc + fi + # Create a symlink ${CT_TARGET}-cc to ${CT_TARGET}-gcc to always be able # to call the C compiler with the same, somewhat canonical name. # check whether compiler has an extension diff -r 986e90e1ca27 -r 6c5658b8b588 scripts/build/debug/300-gdb.sh --- a/scripts/build/debug/300-gdb.sh Wed Nov 16 17:36:17 2011 -0500 +++ b/scripts/build/debug/300-gdb.sh Wed Nov 16 10:06:21 2011 +1300 @@ -155,6 +155,12 @@ CT_DoLog EXTRA "Installing cross-gdb" CT_DoExecLog ALL make install + if [ "${CT_BUILD_MANUALS}" = "y" ]; then + CT_DoLog EXTRA "Building and installing the cross-GDB manuals" + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + CT_DoExecLog ALL make install-{pdf,html}-gdb + fi + if [ "${CT_GDB_INSTALL_GDBINIT}" = "y" ]; then CT_DoLog EXTRA "Install '.gdbinit' template" # See in scripts/build/internals.sh for why we do this diff -r 986e90e1ca27 -r 6c5658b8b588 scripts/build/libc/glibc-eglibc.sh-common --- a/scripts/build/libc/glibc-eglibc.sh-common Wed Nov 16 17:36:17 2011 -0500 +++ b/scripts/build/libc/glibc-eglibc.sh-common Wed Nov 16 10:06:21 2011 +1300 @@ -303,6 +303,18 @@ install_root="${CT_SYSROOT_DIR}" \ install + if [ "${CT_BUILD_MANUALS}" = "y" ]; then + CT_DoLog EXTRA "Building and installing the C library manual" + # Omit JOBSFLAGS as GLIBC has problems building the + # manuals in parallel + CT_DoExecLog ALL make pdf html + # EGLIBC doesn't have a install-{pdf.html} and leaves the manuals + # in the source directory + CT_DoExecLog ALL mkdir -p ${CT_PREFIX_DIR}/share/doc + CT_DoExecLog ALL cp -av ${src_dir}/manual/*.pdf ${src_dir}/manual/libc \ + ${CT_PREFIX_DIR}/share/doc + fi + if [ "${CT_LIBC_LOCALES}" = "y" ]; then do_libc_locales fi