docs/overview.txt
changeset 192 cea313af395e
parent 182 223c84ec2d90
child 197 9383bf4a2e2e
     1.1 --- a/docs/overview.txt	Sun Jul 01 19:04:20 2007 +0000
     1.2 +++ b/docs/overview.txt	Mon Jul 02 17:47:17 2007 +0000
     1.3 @@ -1,7 +1,7 @@
     1.4  File.........: overview.txt
     1.5  Content......: Overview of how ct-ng works.
     1.6  Copyrigth....: (C) 2007 Yann E. MORIN <yann.morin.1998@anciens.enib.fr>
     1.7 -License......: see COPYING in the root of this package
     1.8 +License......: Creative Commons Attribution Share Alike (CC-by-sa), v2.5
     1.9  
    1.10  ________________
    1.11                 /
    1.12 @@ -93,15 +93,15 @@
    1.13  using a curses-based menu. It is assumed you now how to handle this.
    1.14  
    1.15  To enter the menu, type:
    1.16 -  make menuconfig
    1.17 +  ct-ng menuconfig
    1.18  
    1.19  Almost every config item has a help entry. Read it carefully.
    1.20  
    1.21  String and number options can refer to environment variables. In such a case,
    1.22 -you  must use the shell syntax: ${VAR}. No such option is ever needed by make.
    1.23 -You need to neither single- nor double-quote the string options.
    1.24 +you must use the shell syntax: ${VAR}. You shall neither single- nor double-
    1.25 +quote the string options.
    1.26  
    1.27 -There are three environment variablea that are computed by crosstool-NG, and
    1.28 +There are three environment variables that are computed by crosstool-NG, and
    1.29  that you can use:
    1.30  
    1.31  CT_TARGET:
    1.32 @@ -117,7 +117,7 @@
    1.33      ${CT_TOP_DIR}/patches.myproject
    1.34  
    1.35  CT_VERSION:
    1.36 -  The version of crosstool-NG you are using. Not much help for you, but it's
    1.37 +  The version of crosstool-NG you are using. Not much use for you, but it's
    1.38    there if you need it.
    1.39  
    1.40  
    1.41 @@ -155,7 +155,7 @@
    1.42  value for those options are then stored in a configuration file.
    1.43  
    1.44  To build the toolchain, simply type:
    1.45 -  make
    1.46 +  ct-ng
    1.47  
    1.48  This will use the above configuration to retrieve, extract and patch the
    1.49  components, build, install and eventually test your newly built toolchain.
    1.50 @@ -164,7 +164,7 @@
    1.51  it at will.
    1.52  
    1.53  In any case, you can get some terse help. Just type:
    1.54 -  make help
    1.55 +  ct-ng help
    1.56  
    1.57  
    1.58  Stoping and restarting a build |
    1.59 @@ -172,25 +172,25 @@
    1.60  
    1.61  If you want to stop the build after a step you are debugging, you can pass the
    1.62  variable STOP to make:
    1.63 -  make STOP=some_step
    1.64 +  ct-ng STOP=some_step
    1.65  
    1.66  Conversely, if you want to restart a build at a specific step you are
    1.67  debugging, you can pass the RESTART variable to make:
    1.68 -  make RESTART=some_step
    1.69 +  ct-ng RESTART=some_step
    1.70  
    1.71  Alternatively, you can call make with the name of a step to just do that step:
    1.72 -  make libc_headers
    1.73 +  ct-ng libc_headers
    1.74  is equivalent to:
    1.75 -  make RESTART=libs_headers STOP=libc_headers
    1.76 +  ct-ng RESTART=libs_headers STOP=libc_headers
    1.77  
    1.78  The shortcuts -step_name and step_name- allow to respectively stop or restart
    1.79  at that step. Thus:
    1.80 -  make -libc_headers        and:    make libc_headers-
    1.81 +  ct-ng -libc_headers        and:    ct-ng libc_headers-
    1.82  are equivalent to:
    1.83 -  make STOP=libc_headers    and:    make RESTART=libc_headers
    1.84 +  ct-ng STOP=libc_headers    and:    ct-ng RESTART=libc_headers
    1.85  
    1.86  To obtain the list of acceptable steps, please call:
    1.87 -  make liststeps
    1.88 +  ct-ng liststeps
    1.89  
    1.90  Note that in order to restart a build, you'll have to say 'Y' to the config
    1.91  option CT_DEBUG_CT_SAVE_STEPS, and that the previous build effectively went
    1.92 @@ -201,7 +201,7 @@
    1.93  -------------------------------*
    1.94  
    1.95  You can test-build all samples; simply call:
    1.96 -  make regtest
    1.97 +  ct-ng regtest
    1.98  
    1.99  ___________________
   1.100                    /