# HG changeset patch
# User "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
# Date 1311528242 -7200
# Node ID 8e793413baae5a5705eab7f89545a44d2c063146
# Parent  d325be92e763b248ccb1578cd553f22db4a9ca05
cc/gcc: fix core backend's API doc

Make it more in line with the final backend's doc,
and make it simpler as well.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>

diff -r d325be92e763 -r 8e793413baae scripts/build/cc/gcc.sh
--- a/scripts/build/cc/gcc.sh	Sun Jul 24 19:33:04 2011 +0200
+++ b/scripts/build/cc/gcc.sh	Sun Jul 24 19:24:02 2011 +0200
@@ -142,16 +142,18 @@
 
 #------------------------------------------------------------------------------
 # Build core gcc
-# This function is used to build both the static and the shared core C compiler,
-# with or without the target libgcc. We need to know wether:
-#  - we're building static, shared or bare metal: mode=[static|shared|baremetal]
-#  - we need to build libgcc or not             : build_libgcc=[yes|no]       (default: no)
-#  - we need to build libstdc++ or not          : build_libstdcxx=[yes|no]    (default: no)
-#  - we need to build statically linked or not  : build_staticlinked=[yes|no] (default: no)
-#  - where to find the companion libs (prefix)  : complibs=<prefix_dir>       (no default value)
-#  - the prefix to install into (directory)     : prefix=<directory>          (no default value)
-#  - the machine we will run on (tuple)         : host=<tuple>                (no default tuple)
-#  - the CFLAGS to use                          : cflags=<CFLAGS>             (empty)
+# This function is used to build the core C compiler.
+# Usage: do_cc_core_backend param=value [...]
+#   Parameter           : Definition                                : Type      : Default
+#   mode                : build a 'static', 'shared' or 'baremetal' : string    : (none)
+#   host                : the machine the core will run on          : tuple     : (none)
+#   prefix              : dir prefix to install into                : dir       : (none)
+#   complibs            : dir where complibs are isntalled          : dir       : (none)
+#   build_libgcc        : build libgcc or not                       : bool      : no
+#   build_libstdcxx     : build libstdc++ or not                    : bool      : no
+#   build_staticlinked  : build statically linked or not            : bool      : no
+#   build_manuals       : whether to build manuals or not           : bool      : no
+#   cflags              : host CFLAGS to use                        : string    : (empty)
 # Usage: do_cc_core_backend mode=[static|shared|baremetal] build_libgcc=[yes|no] build_staticlinked=[yes|no]
 do_cc_core_backend() {
     local mode
@@ -499,9 +501,8 @@
 }
 
 #------------------------------------------------------------------------------
-# Build final gcc
-# Usage: do_cc_backend param=value ...
-# and so on for other parameters:
+# Build the final gcc
+# Usage: do_cc_backend param=value [...]
 #   Parameter     : Definition                          : Type      : Default
 #   host          : the host we run onto                : tuple     : (none)
 #   prefix        : the runtime prefix                  : dir       : (none)