config/global.in
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sun Jun 17 12:11:16 2007 +0000 (2007-06-17)
changeset 168 45811aef4097
parent 121 82e69d88119b
child 173 8665ee5dcf8f
permissions -rw-r--r--
scripts/showSamples.sh:
- revert sample dumping to not show the components versions;

docs/overview.txt:
- reorder docs/overview.txt so that configuring comes before running,
- tell about regtest;

Makefile:
config/global.in:
- point to docs/overview.txt for the list of steps;
     1 # Overall toolchain configuration: paths, jobs, etc...
     2 
     3 # Ah, this option is here to break the dependency tracking, and allow
     4 # dependent option to line-up with the options they depend on ,rather
     5 # than being indented
     6 config FOOBAR
     7     bool
     8     default n
     9 
    10 menu "Paths and misc options"
    11 
    12 comment "Crosstool behavior"
    13 
    14 config EXPERIMENTAL
    15     bool
    16     prompt "Try features marked as EXPERIMENTAL"
    17     default n
    18     help
    19       If you set this to Y, then you will be able to try very experimental
    20       features.
    21       
    22       Experimental features can be one of:
    23         - working, in which case you should tell me it is!
    24         - buggy, in which case you could try patching and send me the result
    25         - unfinished, in which case you could try hacking it and send me the result
    26         - non-existant, in which case you could also try hacking it in and send the result
    27 
    28 config OBSOLETE
    29     bool
    30     prompt "Use obsolete features"
    31     default n
    32     help
    33       If you set this to Y, you will be able to select obsolete features.
    34       
    35       Such obsolete features are the use of old kernel headers, old
    36       gcc versions, etc...
    37 
    38 config DEBUG_CT
    39     bool
    40     prompt "Debug crosstool-NG"
    41     default n
    42     help
    43       Say 'y' here to get some debugging options
    44 
    45 if DEBUG_CT
    46 
    47 config DEBUG_CT_PAUSE_STEPS
    48     bool
    49     prompt "Pause between every steps"
    50     default n
    51     help
    52       Say 'y' if you intend to attend the build, and want to investigate
    53       the result of each steps before running the next one.
    54 
    55 config DEBUG_CT_SAVE_STEPS
    56     bool
    57     prompt "Save intermediate steps"
    58     default n
    59     help
    60       If you say 'y' here, then you will be able to restart crosstool-NG at
    61       any step.
    62       
    63       It is not currently possible to rstart at any of the debug facility.
    64       They are treated as a whole.
    65 
    66       See docs/overview.txt for the list of steps.
    67 
    68 config DEBUG_CT_SAVE_STEPS_GZIP
    69     bool
    70     prompt "gzip saved states"
    71     default y
    72     depends on DEBUG_CT_SAVE_STEPS
    73     help
    74       If you are tight on space, then you can ask to gzip the saved states
    75       tarballs. On the other hand, this takes some longer time...
    76       
    77       To lose as less time as possible, the gzip process is done with a low
    78       compression ratio (-3), which gives roughly 70% gain in size. Going
    79       further doesn't gain much, and takes far more time (believe me, I've
    80       got figures here! :-) ).
    81 
    82 endif
    83 
    84 comment "Build behavior"
    85 
    86 config PARALLEL_JOBS
    87     int
    88     prompt "Number of parallel jobs"
    89     default 1
    90     help
    91       Number of jobs make will be allowed to run concurently.
    92       Set this higher than the number of processors you have, but not too high.
    93       A good rule of thumb is twice the number of processors you have.
    94       
    95       Enter 1 (or 0) to have only one job at a time.
    96 
    97 config LOAD
    98     int
    99     prompt "Maximum allowed load"
   100     default 0
   101     help
   102       Specifies that no new jobs should be started if there are others jobs
   103       running and the load average is at least this value.
   104       
   105       Makes sense on SMP machines only.
   106       
   107       Enter 0 to have no limit on the load average.
   108       
   109       Note: only the integer part of the load is allowed here (you can't enter
   110             0.75 for example).
   111 
   112 config NICE
   113     int
   114     prompt "Nice level"
   115     default 0
   116     range 0 19
   117     help
   118       Renices the build process up.
   119 
   120 config USE_PIPES
   121     bool
   122     prompt "Use -pipe"
   123     default y
   124     help
   125       Use gcc's option -pipe to use pipes rather than temp files when building
   126       the toolchain.
   127 
   128 comment "Paths"
   129 
   130 config LOCAL_TARBALLS_DIR
   131     string
   132     prompt "Local tarballs directory"
   133     default ""
   134     help
   135       If you have previously downloaded the tarballs, enter the PATH where
   136       you stored them here.
   137 
   138 config PREFIX_DIR
   139     string
   140     prompt "Prefix directory"
   141     default "${HOME}/${CT_TARGET}"
   142     help
   143       This is the path the toolchain will run from.
   144 
   145 config INSTALL_DIR
   146     string
   147 #    prompt "Install directory"
   148     default "${CT_PREFIX_DIR}"
   149 #    help
   150 #      This is the path the target will be installed into.
   151 #      
   152 #      Normally, you would set this to ${CT_PREFIX_DIR}, but if for some reasons
   153 #      you can't write there, you can install somewhere else and have a third
   154 #      person do the install for you.
   155 #      The reason you might also want to install elsewhere is if you are going
   156 #      to package your shinny new toolchain for distribution.
   157 
   158 config CUSTOM_PATCH
   159     bool
   160     prompt "Use custom patch directory"
   161     default n
   162     help
   163       If you have custom patches that you want to be applied, say 'Y' here and
   164       enter the path directory below.
   165       
   166       Note that you must ensure that the patch directory is arranged the same
   167       way the official directory is.
   168 
   169 config CUSTOM_PATCH_ONLY
   170     bool
   171     prompt "Only use custom patches"
   172     default n
   173     depends on CUSTOM_PATCH
   174     help
   175       Don't apply patches coming with CT-NG, only those patches available in
   176       the directory below.
   177       
   178       If you say 'N' here, then the patches provided with CT-NG will be applied
   179       first, and then your patches.
   180 
   181 config CUSTOM_PATCH_DIR
   182     string
   183     prompt "Custom patch directory"
   184     default ""
   185     depends on CUSTOM_PATCH
   186     help
   187       Enter the custom patch directory here.
   188 
   189 config REMOVE_DOCS
   190     bool
   191     prompt "Remove documentation"
   192     default n
   193     help
   194       Remove the installed documentation (man and info pages).
   195       Gains around 8MiB for a uClibc-based, C and C++ compiler.
   196 
   197 comment "Downloading"
   198 
   199 config FORCE_DOWNLOAD
   200     bool
   201     prompt "Force downloads"
   202     default n
   203     help
   204       Force downloading tarballs, even if one already exists.
   205       
   206       Usefull if you suspect a tarball to be damaged.
   207 
   208 config ONLY_DOWNLOAD
   209     bool
   210     prompt "Stop after downloading tarballs"
   211     default n
   212     help
   213       Only download the tarballs. Exit once it done.
   214       
   215       Usefull to pre-retrieve the tarballs before going off-line.
   216 
   217 config FOOBAR
   218 
   219 comment "Extracting"
   220     depends on ! ONLY_DOWNLOAD
   221 
   222 config FORCE_EXTRACT
   223     bool
   224     prompt "Force extractions"
   225     depends on ! ONLY_DOWNLOAD
   226     default n
   227     help
   228       Force extraction of already exctracted tarballs.
   229       
   230       Usefull if you suspect a previous extract did not complete (eg. broken
   231       tarball), or you added a new set of patches for this component.
   232 
   233 config ONLY_EXTRACT
   234     bool
   235     prompt "Stop after extracting tarballs"
   236     depends on ! ONLY_DOWNLOAD
   237     default n
   238     help
   239       Exit after unpacking and patching tarballs.
   240       
   241       Usefull to look at the code before doing the build itself.
   242 
   243 comment "Logging"
   244 
   245 choice
   246     bool
   247     prompt "Maximum log level to see:"
   248     default LOG_INFO
   249 
   250 config LOG_ERROR
   251     bool
   252     prompt "ERROR"
   253     help
   254       The build will be silent.
   255       Only if there is an error will you see a mesage.
   256 
   257 config LOG_WARN
   258     bool
   259     prompt "WARN"
   260     help
   261       The same as above, plus warnings.
   262 
   263 config LOG_INFO
   264     bool
   265     prompt "INFO"
   266     help
   267       The same as above, plus informational messages (main steps).
   268 
   269 config LOG_EXTRA
   270     bool
   271     prompt "EXTRA"
   272     help
   273       The same as above, plus extra messages (sub-steps).
   274 
   275 config LOG_DEBUG
   276     bool
   277     prompt "DEBUG"
   278     help
   279       The same as above, plus lots of crosstool-NG debug information.
   280 
   281 config LOG_ALL
   282     bool
   283     prompt "ALL"
   284     help
   285       The same as above, plus all components build messages (very noisy!).
   286 
   287 endchoice
   288 
   289 config LOG_LEVEL_MAX
   290     string
   291     default "ERROR"   if LOG_ERROR
   292     default "WARN"    if LOG_WARN
   293     default "INFO"    if LOG_INFO
   294     default "EXTRA"   if LOG_EXTRA
   295     default "DEBUG"   if LOG_DEBUG
   296     default "ALL"     if LOG_ALL
   297 
   298 config LOG_SEE_TOOLS_WARN
   299     bool
   300     prompt "Warnings from the tool builds as CT warnings"
   301     default n
   302     depends on ! LOG_ERROR
   303     help
   304       Treat warnings fron the different tools as crosstool warnings.
   305       If you say 'y' here, then those warnings will be prefixed with
   306       '[WARN ]' instead of the default '[ALL  ]'.
   307 
   308       You can safely say 'n' here. Those warnings will anyway be
   309       recorded in the log file (provided you configured one).
   310 
   311 config LOG_PROGRESS_BAR
   312     bool
   313     prompt "Progress bar"
   314     default n
   315     depends on ! LOG_ALL
   316     help
   317       If you say 'y' here, you'll be able to see the elapsed time.
   318       
   319       As a bonus, you'll also get a rotating bar (/-\|) showing you
   320       that the build is not stalled (the bar rotates 1/4 every 10 lines
   321       of components build log).
   322 
   323       Note that the elapsed time can stall for a little while if a
   324       component has long commands, as the elapsed time is only updated
   325       each line.
   326 
   327 config LOG_TO_FILE
   328     bool
   329     prompt "Log to a file"
   330     default y
   331     help
   332       Save *full* logs to a file. Even log levels you didn't specify above
   333       will be available in this file.
   334 
   335       As a bonus, there is a script in tools/extractConfig.sh that is able
   336       to extract the configuration of crosstool-NG from the log file.
   337 
   338       Definitely, say Y.
   339 
   340 config LOG_FILE
   341     string
   342     prompt "Log file"
   343     default "${CT_PREFIX_DIR}/${CT_TARGET}.log"
   344     depends on LOG_TO_FILE
   345     help
   346       File name into which to put logs.
   347 
   348 endmenu