docs/overview.txt
changeset 476 29b33ee36ef6
parent 456 e34a92db3a73
child 544 6b15ef33e8f2
     1.1 --- a/docs/overview.txt	Sun Apr 27 09:57:50 2008 +0000
     1.2 +++ b/docs/overview.txt	Fri May 02 21:53:09 2008 +0000
     1.3 @@ -146,7 +146,7 @@
     1.4  will support, the version of the components you want to use, etc... The
     1.5  value for those options are then stored in a configuration file.
     1.6  
     1.7 -The configurator works the same way you configure your Linux kernel.It is
     1.8 +The configurator works the same way you configure your Linux kernel. It is
     1.9  assumed you now how to handle this.
    1.10  
    1.11  To enter the menu, type:
    1.12 @@ -177,9 +177,8 @@
    1.13    The version of crosstool-NG you are using. Not much use for you, but it's
    1.14    there if you need it.
    1.15  
    1.16 -
    1.17  Interesting config options |
    1.18 ----------------------------*
    1.19 +---------------------------+
    1.20  
    1.21  CT_LOCAL_TARBALLS_DIR:
    1.22    If you already have some tarballs in a direcotry, enter it here. That will
    1.23 @@ -221,7 +220,7 @@
    1.24    Show broken versions or tools. Some usefull tools are currently broken: they
    1.25    won't compile, run, or worse, cause defects when running. But if you are
    1.26    brave enough, you can try and debug them. They are hidden behind CT_BROKEN,
    1.27 -  which itself is hidden behind EXPERIMENTAL.
    1.28 +  which itself is hidden behind CT_EXPERIMENTAL.
    1.29  
    1.30  Re-building an existing toolchain |
    1.31  ----------------------------------+
    1.32 @@ -258,9 +257,8 @@
    1.33  or:
    1.34    man 1 ct-ng
    1.35  
    1.36 -
    1.37  Stopping and restarting a build |
    1.38 --------------------------------*
    1.39 +--------------------------------+
    1.40  
    1.41  If you want to stop the build after a step you are debugging, you can pass the
    1.42  variable STOP to make:
    1.43 @@ -288,16 +286,14 @@
    1.44  option CT_DEBUG_CT_SAVE_STEPS, and that the previous build effectively went
    1.45  that far.
    1.46  
    1.47 -
    1.48  Testing all toolchains at once |
    1.49 --------------------------------*
    1.50 +-------------------------------+
    1.51  
    1.52  You can test-build all samples; simply call:
    1.53    ct-ng regtest
    1.54  
    1.55 -
    1.56  Overriding the number of // jobs |
    1.57 ----------------------------------*
    1.58 +---------------------------------+
    1.59  
    1.60  If you want to override the number of jobs to run in // (the -j option to
    1.61  make), you can either re-enter the menuconfig, or simply add it on the command
    1.62 @@ -328,6 +324,17 @@
    1.63    make CROSS_COMPILE=your-target-tuple-
    1.64  and so on...
    1.65  
    1.66 +It is strongly advised not to use the toolchain sys-root directory as an
    1.67 +install directory for your programms/packages. If you do so, you will not be
    1.68 +able to use your toolchain for another project. It is even strongly advised
    1.69 +that your toolchain is chmod-ed to read-only once successfully build, so that
    1.70 +you don't go polluting your toolchain with your programms/packages' files.
    1.71 +
    1.72 +Thus, when you build a program/package, install it in a separate directory,
    1.73 +eg. /your/root. This directory is the /image/ of what would be in the root file
    1.74 +system of your target, and will contain all that your programms/packages have
    1.75 +installed.
    1.76 +
    1.77  When your root directory is ready, it is still missing some important bits: the
    1.78  toolchain's libraries. To populate your root directory with those libs, just
    1.79  run:
    1.80 @@ -429,7 +436,7 @@
    1.81  Makefile-based.
    1.82  
    1.83  Makefile front-end |
    1.84 --------------------*
    1.85 +-------------------+
    1.86  
    1.87  The entry point to crosstool-NG is the Makefile script "ct-ng". Calling this
    1.88  script with an action will act exactly as if the Makefile was in the current
    1.89 @@ -453,7 +460,7 @@
    1.90  was unbuildable.
    1.91  
    1.92  Kconfig parser |
    1.93 ----------------*
    1.94 +---------------+
    1.95  
    1.96  The kconfig language is a hacked version, vampirised from the toybox project
    1.97  by Rob LANDLEY (http://www.landley.net/code/toybox/), itself coming from the
    1.98 @@ -466,7 +473,7 @@
    1.99  patches.
   1.100  
   1.101  Architecture-specific |
   1.102 -----------------------*
   1.103 +----------------------+
   1.104  
   1.105  An architecture is defined by:
   1.106  
   1.107 @@ -555,8 +562,17 @@
   1.108       - default to:
   1.109         see above.
   1.110       
   1.111 +Adding a new version of a conponent |
   1.112 +------------------------------------+
   1.113 +
   1.114 +When a new component, such as the Linux kernel, gcc or any other is released,
   1.115 +adding the new version to crosstool-NG is quite easy. There is a script that
   1.116 +will do all that for you:
   1.117 +  tools/addToolVersion.sh
   1.118 +
   1.119 +Run it with no option to get some help.
   1.120  
   1.121  Build scripts |
   1.122 ---------------*
   1.123 +--------------+
   1.124  
   1.125  To Be Written later...