path: root/docs
diff options
authorYann E. MORIN" <>2008-06-25 14:06:49 (GMT)
committerYann E. MORIN" <>2008-06-25 14:06:49 (GMT)
commit1b6adf776fb2c13673a0ba72b1100f7073956781 (patch)
treeed7bc87422bc0a235f49ddf3ce87a5916630d844 /docs
parent988e11fc08ff7ed7e8925d5f012634b5b62077f2 (diff)
Update documentation.
/trunk/docs/overview.txt | 37 27 10 0 +++++++++++++++++++++++++++---------- /trunk/docs/ | 18 1 17 0 +----------------- 2 files changed, 28 insertions(+), 27 deletions(-)
Diffstat (limited to 'docs')
2 files changed, 28 insertions, 27 deletions
diff --git a/docs/ b/docs/
index 49dbdca..2f11a3f 100644
--- a/docs/
+++ b/docs/
@@ -64,12 +64,6 @@ with the target tuple they represent.
Builds the configured toolchain.
-.B liststeps
-Lists all build steps available (see
.B clean
Remove files generated by
.B crosstool-NG
@@ -114,7 +108,7 @@ Respectively stops and restarts the build just before this step. To restart a
step, a previous build should have run at least to that step, or further.
The list of steps is vailable with the action
-.BR liststeps .
+.BR list-steps .
@@ -152,16 +146,6 @@ although
will refuse to install toolchains in some well known critical directories.
-.MTO "" "Yann E. MORIN" ""
-.URL "" "" ""
-.B crosstool
-(see section titled
-scripts to be more easily maintainable, added the Kconfig configurator, some
-patches, support for linux headers installation, and support for uClibc-based
Please consult the file
for a list of contributors.
diff --git a/docs/overview.txt b/docs/overview.txt
index 8515a11..8cc507e 100644
--- a/docs/overview.txt
+++ b/docs/overview.txt
@@ -135,14 +135,28 @@ Some people contibuted code that couldn't get merged for various reasons. This
code is available as patches in the contrib/ sub-directory. These patches are
to be applied to the source of crosstool-NG, prior to installing.
+An easy way to use contributed code is to pass the --with-contrib= option to
+./configure. The possible values depend upon which contributions are packaged
+with your version, but you can get with it with passing one of those two
+special values:
+ --with-contrib=list
+ will list all available contributions
+ --with-contrib=all
+ will select all avalaible contributions
+There is no guarantee that a particuliar contribution applies to the current
+version of crosstool-ng, or that it will work at all. Use contributions at
+your own risk.
Configuring crosstool-NG /
-crosstool-NG is configured by a configurator presenting a menu-stuctured set of
-options. These options let you specify the way you want your toolchain built,
-where you want it installed, what architecture and specific processor it
+crosstool-NG is configured with a configurator presenting a menu-stuctured set
+of options. These options let you specify the way you want your toolchain
+built, where you want it installed, what architecture and specific processor it
will support, the version of the components you want to use, etc... The
value for those options are then stored in a configuration file.
@@ -230,13 +244,16 @@ to create a new toolchain. That needs a very little bit of effort on your side
but is quite easy. The options to build a toolchain are saved in the build log
file that is saved within the toolchain. crosstool-NG can extract those options
to recreate a new configuration:
- ct-ng extractconfig </path/to/your/build.log
+ ct-ng extractconfig </path/to/your/build.log >.config
will extract those options, prompt you for the new ones, which you can later
edit with menuconfig.
Of course, if your build log was compressed, you'd have to use something like:
- bzcat /path/to/your/build.log.bz2 |ct-ng extractconfig
+ bzcat /path/to/your/build.log.bz2 |ct-ng extractconfig >.config
+Then, once the configuration has been extracted, run:
+ ct-ng oldconfig
@@ -271,7 +288,7 @@ debugging, you can pass the RESTART variable to make:
Alternatively, you can call make with the name of a step to just do that step:
ct-ng libc_headers
is equivalent to:
- ct-ng RESTART=libs_headers STOP=libc_headers
+ ct-ng RESTART=libc_headers STOP=libc_headers
The shortcuts +step_name and step_name+ allow to respectively stop or restart
at that step. Thus:
@@ -325,14 +342,14 @@ or
and so on...
It is strongly advised not to use the toolchain sys-root directory as an
-install directory for your programms/packages. If you do so, you will not be
+install directory for your programs/packages. If you do so, you will not be
able to use your toolchain for another project. It is even strongly advised
that your toolchain is chmod-ed to read-only once successfully build, so that
-you don't go polluting your toolchain with your programms/packages' files.
+you don't go polluting your toolchain with your programs/packages' files.
Thus, when you build a program/package, install it in a separate directory,
eg. /your/root. This directory is the /image/ of what would be in the root file
-system of your target, and will contain all that your programms/packages have
+system of your target, and will contain all that your programs/packages have
When your root directory is ready, it is still missing some important bits: the
@@ -562,7 +579,7 @@ The "functions" file API:
- default to:
see above.
-Adding a new version of a conponent |
+Adding a new version of a component |
When a new component, such as the Linux kernel, gcc or any other is released,