From patchwork Tue Nov 15 21:07:39 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Hope X-Patchwork-Id: 5157 Return-Path: X-Original-To: patchwork@peony.canonical.com Delivered-To: patchwork@peony.canonical.com Received: from fiordland.canonical.com (fiordland.canonical.com [91.189.94.145]) by peony.canonical.com (Postfix) with ESMTP id 1F65B23E13 for ; Tue, 15 Nov 2011 21:07:47 +0000 (UTC) Received: from mail-fx0-f52.google.com (mail-fx0-f52.google.com [209.85.161.52]) by fiordland.canonical.com (Postfix) with ESMTP id 09D43A1827D for ; Tue, 15 Nov 2011 21:07:47 +0000 (UTC) Received: by faaa26 with SMTP id a26so1292431faa.11 for ; Tue, 15 Nov 2011 13:07:46 -0800 (PST) Received: by 10.152.104.1 with SMTP id ga1mr18131909lab.40.1321391266742; Tue, 15 Nov 2011 13:07:46 -0800 (PST) X-Forwarded-To: linaro-patchwork@canonical.com X-Forwarded-For: patch@linaro.org linaro-patchwork@canonical.com Delivered-To: patches@linaro.org Received: by 10.152.41.198 with SMTP id h6cs57256lal; Tue, 15 Nov 2011 13:07:46 -0800 (PST) Received: by 10.52.26.14 with SMTP id h14mr44955942vdg.132.1321391263640; Tue, 15 Nov 2011 13:07:43 -0800 (PST) Received: from unit0.ironport.snap.net.nz (unit0.ironport.snap.net.nz. [202.37.100.104]) by mx.google.com with ESMTP id k2si11272722ybi.102.2011.11.15.13.07.41; Tue, 15 Nov 2011 13:07:43 -0800 (PST) Received-SPF: neutral (google.com: 202.37.100.104 is neither permitted nor denied by best guess record for domain of michael.hope@linaro.org) client-ip=202.37.100.104; Authentication-Results: mx.google.com; spf=neutral (google.com: 202.37.100.104 is neither permitted nor denied by best guess record for domain of michael.hope@linaro.org) smtp.mail=michael.hope@linaro.org X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Av0EAJfTwk57/y/M/2dsb2JhbABDFqlYgnk/Mg08FR9OE4gKuGGKEQSZbYxV X-IronPort-AV: E=Sophos;i="4.69,517,1315137600"; d="scan'208";a="85334772" Received: from rupert.snap.net.nz ([202.37.100.140]) by smtp0.ironport.snap.net.nz with ESMTP; 16 Nov 2011 10:07:40 +1300 X-Sender-IP: 123.255.47.204 X-Sender-IP: 123.255.47.204 X-Sender-IP: 123.255.47.204 Received: from [127.0.1.1] (204.47.255.123.static.snap.net.nz [123.255.47.204]) by rupert.snap.net.nz (Postfix) with ESMTPS id 3C5381FD39; Wed, 16 Nov 2011 10:07:40 +1300 (NZDT) MIME-Version: 1.0 Subject: [PATCH] scripts: add support for building manuals X-Mercurial-Node: ae6b7b791db59c66639a4eb0aa6dc172c9d399c6 Message-Id: User-Agent: Mercurial-patchbomb/1.7.5 Date: Wed, 16 Nov 2011 10:07:39 +1300 From: Michael Hope To: "Yann E. MORIN" Cc: crossgcc@sourceware.org, patches@linaro.org # HG changeset patch # User Michael Hope # Date 1321391181 -46800 # Branch add-manuals # Node ID ae6b7b791db59c66639a4eb0aa6dc172c9d399c6 # Parent 7f305778ab05e60e58722d21e03e5140588a1438 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. Dodgy: always try install the non-existant GOLD manual. Should really check .config to see if GOLD is enabled. An example of the output is at: http://people.linaro.org/~michaelh/incoming/crosstool-NG/ Signed-off-by: Michael Hope diff -r 7f305778ab05 -r ae6b7b791db5 .hgignore --- a/.hgignore Mon Nov 14 18:12:55 2011 +0100 +++ b/.hgignore Wed Nov 16 10:06:21 2011 +1300 @@ -27,3 +27,4 @@ .build/ # .. and the legacy location targets/ +builds/ \ No newline at end of file diff -r 7f305778ab05 -r ae6b7b791db5 config/global/paths.in --- a/config/global/paths.in Mon Nov 14 18:12:55 2011 +0100 +++ 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" + default n + 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 7f305778ab05 -r ae6b7b791db5 scripts/build/binutils/binutils.sh --- a/scripts/build/binutils/binutils.sh Mon Nov 14 18:12:55 2011 +0100 +++ b/scripts/build/binutils/binutils.sh Wed Nov 16 10:06:21 2011 +1300 @@ -90,6 +90,12 @@ 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" + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + CT_DoExecLog ALL make install-{pdf,html}-{gas,binutils,ld,gold,gprof} + fi + # Install the wrapper if needed if [ "${CT_BINUTILS_LD_WRAPPER}" = "y" ]; then CT_DoLog EXTRA "Installing ld wrapper" diff -r 7f305778ab05 -r ae6b7b791db5 scripts/build/cc/gcc.sh --- a/scripts/build/cc/gcc.sh Mon Nov 14 18:12:55 2011 +0100 +++ 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,12 @@ 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 and installing the GCC manuals" + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + 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 +632,12 @@ CT_DoLog EXTRA "Installing final compiler" CT_DoExecLog ALL make ${JOBSFLAGS} install + if [ "${CT_BUILD_MANUALS}" = "y" ]; then + CT_DoLog EXTRA "Building and installing the GCC manuals" + CT_DoExecLog ALL make ${JOBSFLAGS} pdf html + 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 7f305778ab05 -r ae6b7b791db5 scripts/build/debug/300-gdb.sh --- a/scripts/build/debug/300-gdb.sh Mon Nov 14 18:12:55 2011 +0100 +++ 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 7f305778ab05 -r ae6b7b791db5 scripts/build/libc/glibc-eglibc.sh-common --- a/scripts/build/libc/glibc-eglibc.sh-common Mon Nov 14 18:12:55 2011 +0100 +++ 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