Update docs/overview.txt to match the new way to call crosstool-ng: "ct-ng [action]" in lieu of "make [action]".

This commit is contained in:
Yann E. MORIN" 2007-07-02 17:47:17 +00:00
parent 344a346103
commit c84805249c

View File

@ -1,7 +1,7 @@
File.........: overview.txt
Content......: Overview of how ct-ng works.
Copyrigth....: (C) 2007 Yann E. MORIN <yann.morin.1998@anciens.enib.fr>
License......: see COPYING in the root of this package
License......: Creative Commons Attribution Share Alike (CC-by-sa), v2.5
________________
/
@ -93,15 +93,15 @@ crosstool-NG is configured the same way you configure your Linux kernel: by
using a curses-based menu. It is assumed you now how to handle this.
To enter the menu, type:
make menuconfig
ct-ng menuconfig
Almost every config item has a help entry. Read it carefully.
String and number options can refer to environment variables. In such a case,
you must use the shell syntax: ${VAR}. No such option is ever needed by make.
You need to neither single- nor double-quote the string options.
you must use the shell syntax: ${VAR}. You shall neither single- nor double-
quote the string options.
There are three environment variablea that are computed by crosstool-NG, and
There are three environment variables that are computed by crosstool-NG, and
that you can use:
CT_TARGET:
@ -117,7 +117,7 @@ CT_TOP_DIR:
${CT_TOP_DIR}/patches.myproject
CT_VERSION:
The version of crosstool-NG you are using. Not much help for you, but it's
The version of crosstool-NG you are using. Not much use for you, but it's
there if you need it.
@ -155,7 +155,7 @@ will support, the version of the components you want to use, etc... The
value for those options are then stored in a configuration file.
To build the toolchain, simply type:
make
ct-ng
This will use the above configuration to retrieve, extract and patch the
components, build, install and eventually test your newly built toolchain.
@ -164,7 +164,7 @@ You are then free to add the toolchain /bin directory in your PATH to use
it at will.
In any case, you can get some terse help. Just type:
make help
ct-ng help
Stoping and restarting a build |
@ -172,25 +172,25 @@ Stoping and restarting a build |
If you want to stop the build after a step you are debugging, you can pass the
variable STOP to make:
make STOP=some_step
ct-ng STOP=some_step
Conversely, if you want to restart a build at a specific step you are
debugging, you can pass the RESTART variable to make:
make RESTART=some_step
ct-ng RESTART=some_step
Alternatively, you can call make with the name of a step to just do that step:
make libc_headers
ct-ng libc_headers
is equivalent to:
make RESTART=libs_headers STOP=libc_headers
ct-ng RESTART=libs_headers STOP=libc_headers
The shortcuts -step_name and step_name- allow to respectively stop or restart
at that step. Thus:
make -libc_headers and: make libc_headers-
ct-ng -libc_headers and: ct-ng libc_headers-
are equivalent to:
make STOP=libc_headers and: make RESTART=libc_headers
ct-ng STOP=libc_headers and: ct-ng RESTART=libc_headers
To obtain the list of acceptable steps, please call:
make liststeps
ct-ng liststeps
Note that in order to restart a build, you'll have to say 'Y' to the config
option CT_DEBUG_CT_SAVE_STEPS, and that the previous build effectively went
@ -201,7 +201,7 @@ Testing all toolchains at once |
-------------------------------*
You can test-build all samples; simply call:
make regtest
ct-ng regtest
___________________
/