manual/user guide/customization: re-order introduction
[buildroot-gz.git] / Config.in
blob24aa883111ccd16de317b2d91759ace5b1327d6b
3 mainmenu "Buildroot $BR2_VERSION Configuration"
5 config BR2_HAVE_DOT_CONFIG
6         bool
7         default y
9 config BR2_VERSION
10         string
11         option env="BR2_VERSION_FULL"
13 config BR2_HOSTARCH
14         string
15         option env="HOSTARCH"
17 config BR2_EXTERNAL
18         string
19         option env="BR2_EXTERNAL"
21 # Hidden boolean selected by packages in need of Java in order to build
22 # (example: xbmc)
23 config BR2_NEEDS_HOST_JAVA
24         bool
26 # Hidden boolean selected by packages in need of javac in order to build
27 # (example: classpath)
28 config BR2_NEEDS_HOST_JAVAC
29         bool
31 # Hidden boolean selected by packages in need of jar in order to build
32 # (example: classpath)
33 config BR2_NEEDS_HOST_JAR
34         bool
36 # Hidden boolean selected by pre-built packages for x86, when they
37 # need to run on x86-64 machines (example: pre-built external
38 # toolchains, binary tools like SAM-BA, etc.).
39 config BR2_HOSTARCH_NEEDS_IA32_LIBS
40         bool
42 # Hidden boolean selected by packages that need to build 32 bits
43 # binaries with the host compiler, even on 64 bits build machines (e.g
44 # bootloaders).
45 config BR2_HOSTARCH_NEEDS_IA32_COMPILER
46         bool
48 source "arch/Config.in"
50 menu "Build options"
52 menu "Commands"
54 config BR2_WGET
55         string "Wget command"
56         default "wget --passive-ftp -nd -t 3"
58 config BR2_SVN
59         string "Subversion (svn) command"
60         default "svn"
62 config BR2_BZR
63         string "Bazaar (bzr) command"
64         default "bzr"
66 config BR2_GIT
67         string "Git command"
68         default "git"
70 config BR2_CVS
71         string "CVS command"
72         default "cvs"
74 config BR2_LOCALFILES
75         string "Local files retrieval command"
76         default "cp"
78 config BR2_SCP
79         string "Secure copy (scp) command"
80         default "scp"
82 config BR2_SSH
83         string "Secure shell (ssh) command"
84         default "ssh"
86 config BR2_HG
87         string "Mercurial (hg) command"
88         default "hg"
90 config BR2_ZCAT
91         string "zcat command"
92         default "gzip -d -c"
93         help
94           Command to be used to extract a gzip'ed file to stdout.
95           zcat is identical to gunzip -c except that the former may
96           not be available on your system.
97           Default is "gzip -d -c"
98           Other possible values include "gunzip -c" or "zcat".
100 config BR2_BZCAT
101         string "bzcat command"
102         default "bzcat"
103         help
104           Command to be used to extract a bzip2'ed file to stdout.
105           bzcat is identical to bunzip2 -c except that the former may
106           not be available on your system.
107           Default is "bzcat"
108           Other possible values include "bunzip2 -c" or "bzip2 -d -c".
110 config BR2_XZCAT
111         string "xzcat command"
112         default "xzcat"
113         help
114           Command to be used to extract a xz'ed file to stdout.
115           Default is "xzcat"
117 config BR2_TAR_OPTIONS
118         string "Tar options"
119         default ""
120         help
121           Options to pass to tar when extracting the sources.
122           E.g. " -v --exclude='*.svn*'" to exclude all .svn internal files
123           and to be verbose.
125 endmenu
127 config BR2_DEFCONFIG_FROM_ENV
128         string
129         option env="BR2_DEFCONFIG"
131 config BR2_DEFCONFIG
132         string "Location to save buildroot config"
133         default BR2_DEFCONFIG_FROM_ENV if BR2_DEFCONFIG_FROM_ENV != ""
134         default "$(CONFIG_DIR)/defconfig"
135         help
136           When running 'make savedefconfig', the defconfig file will be saved
137           in this location.
139 config BR2_DL_DIR
140         string "Download dir"
141         default "$(TOPDIR)/dl"
142         help
143           Directory to store all the source files that we need to fetch.
144           If the Linux shell environment has defined the BR2_DL_DIR
145           environment variable, then this overrides this configuration item.
147           The default is $(TOPDIR)/dl
149 config BR2_HOST_DIR
150         string "Host dir"
151         default "$(BASE_DIR)/host"
152         help
153           Directory to store all the binary files that are built for the host.
154           This includes the cross compilation toolchain when building the
155           internal buildroot toolchain.
157           The default is $(BASE_DIR)/host
159 menu "Mirrors and Download locations"
161 config BR2_PRIMARY_SITE
162         string "Primary download site"
163         default ""
164         help
165           Primary site to download from. If this option is set then buildroot
166           will try to download package source first from this site and try the
167           default if the file is not found.
168           Valid URIs are URIs recognized by $(WGET) and scp URIs of the form
169           scp://[user@]host:path.
170           NOTE: This works for all packages using the central package
171           infrastructure (generic, autotools, cmake, ...)
173 config BR2_PRIMARY_SITE_ONLY
174         bool "Only allow downloads from primary download site"
175         depends on BR2_PRIMARY_SITE != ""
176         help
177           If this option is enabled, downloads will only be attempted
178           from the primary download site. Other locations, like the
179           package's official download location or the backup download
180           site, will not be considered. Therefore, if the package is
181           not present on the primary site, the download fails.
183           This is useful for project developers who want to ensure
184           that the project can be built even if the upstream tarball
185           locations disappear.
187 if !BR2_PRIMARY_SITE_ONLY
189 config BR2_BACKUP_SITE
190         string "Backup download site"
191         default "http://sources.buildroot.net"
192         help
193           Backup site to download from. If this option is set then buildroot
194           will fall back to download package sources from here if the
195           normal location fails.
197 config BR2_KERNEL_MIRROR
198         string "Kernel.org mirror"
199         default "https://www.kernel.org/pub"
200         help
201           kernel.org is mirrored on a number of servers around the world.
202           The following allows you to select your preferred mirror.
204           Have a look on the kernel.org site for a list of mirrors, then enter
205           the URL to the base directory.  Examples:
207              http://www.XX.kernel.org/pub (XX = country code)
208              http://mirror.aarnet.edu.au/pub/ftp.kernel.org
210 config BR2_GNU_MIRROR
211         string "GNU Software mirror"
212         default "http://ftp.gnu.org/pub/gnu"
213         help
214           GNU has multiple software mirrors scattered around the world.
215           The following allows you to select your preferred mirror.
217           Have a look on the gnu.org site for a list of mirrors, then enter
218           the URL to the base directory.  Examples:
220              http://ftp.gnu.org/pub/gnu
221              http://mirror.aarnet.edu.au/pub/gnu
223 config BR2_DEBIAN_MIRROR
224         string "Debian Software mirror"
225         default "http://ftp.debian.org"
226         help
227           Debian has multiple software mirrors scattered around the world.
228           The following allows you to select your preferred mirror.
230           Usually, just add your country code like XX here:
231           http://ftp.XX.debian.org
233 endif
235 config BR2_LUAROCKS_MIRROR
236         string "LuaRocks mirror"
237         default "http://rocks.moonscript.org"
238         help
239           LuaRocks repository.
241           See http://luarocks.org
243 config BR2_CPAN_MIRROR
244         string "CPAN mirror (Perl packages)"
245         default "http://cpan.metacpan.org"
246         help
247           CPAN (Comprehensive Perl Archive Network) is a repository
248           of Perl packages. It has multiple software mirrors scattered
249           around the world. This option allows you to select a mirror.
251           The list of mirrors is available at:
252           http://search.cpan.org/mirror
254 endmenu
256 config BR2_JLEVEL
257         int "Number of jobs to run simultaneously (0 for auto)"
258         default "0"
259         help
260           Number of jobs to run simultaneously.  If 0, determine
261           automatically according to number of CPUs on the host
262           system.
264 config BR2_CCACHE
265         bool "Enable compiler cache"
266         help
267           This option will enable the use of ccache, a compiler
268           cache. It will cache the result of previous builds to speed
269           up future builds. By default, the cache is stored in
270           $HOME/.buildroot-ccache.
272           Note that Buildroot does not try to invalidate the cache
273           contents when the compiler changes in an incompatible
274           way. Therefore, if you make a change to the compiler version
275           and/or configuration, you are responsible for purging the
276           ccache cache by removing the $HOME/.buildroot-ccache
277           directory.
279 if BR2_CCACHE
281 config BR2_CCACHE_DIR
282         string "Compiler cache location"
283         default "$(HOME)/.buildroot-ccache"
284         help
285           Where ccache should store cached files.
287 config BR2_CCACHE_INITIAL_SETUP
288         string "Compiler cache initial setup"
289         help
290           Initial ccache settings to apply, such as --max-files or --max-size.
292           For example, if your project is known to require more space than the
293           default max cache size, then you might want to increase the cache size
294           to a suitable amount using the -M (--max-size) option.
296           The string you specify here is passed verbatim to ccache.  Refer to
297           ccache documentation for more details.
299           These initial settings are applied after ccache has been compiled.
301 endif
303 config BR2_DEPRECATED
304         bool "Show options and packages that are deprecated or obsolete"
305         help
306           This option shows outdated/obsolete versions of packages and
307           options that are otherwise hidden.
309 if BR2_DEPRECATED
311 config BR2_DEPRECATED_SINCE_2013_11
312         bool
313         default y
315 config BR2_DEPRECATED_SINCE_2014_02
316         bool
317         default y
319 config BR2_DEPRECATED_SINCE_2014_05
320         bool
321         default y
323 config BR2_DEPRECATED_SINCE_2014_08
324         bool
325         default y
327 endif
329 config BR2_ENABLE_DEBUG
330         bool "build packages with debugging symbols"
331         help
332           Build packages with debugging symbols enabled. All libraries
333           and binaries in the 'staging' directory will have debugging
334           symbols, which allows remote debugging even if libraries and
335           binaries are stripped on the target. Whether libraries and
336           binaries are stripped on the target is controlled by the
337           BR2_STRIP_* options below.
339 if BR2_ENABLE_DEBUG
340 choice
341         prompt "gcc debug level"
342         default BR2_DEBUG_2
343         help
344           Set the debug level for gcc
346 config BR2_DEBUG_1
347         bool "debug level 1"
348         help
349           Debug level 1 produces minimal information, enough
350           for making backtraces in parts of the program that
351           you don't plan to debug. This includes descriptions
352           of functions and external variables, but no information
353           about local variables and no line numbers.
355 config BR2_DEBUG_2
356         bool "debug level 2"
357         help
358           The default gcc debug level is 2
360 config BR2_DEBUG_3
361         bool "debug level 3"
362         help
363           Level 3 includes extra information, such as all the
364           macro definitions present in the program. Some debuggers
365           support macro expansion when you use -g3.
366 endchoice
367 endif
369 choice
370         prompt "strip command for binaries on target"
371         default BR2_STRIP_strip
373 config BR2_STRIP_strip
374         bool "strip"
375         depends on !BR2_PACKAGE_HOST_ELF2FLT
376         help
377           Binaries and libraries in the target filesystem will be
378           stripped using the normal 'strip' command. This allows to
379           save space, mainly by removing debugging symbols. Debugging
380           symbols on the target are needed for native debugging, but
381           not when remote debugging is used.
383 config BR2_STRIP_sstrip
384         bool "sstrip"
385         select BR2_PACKAGE_SSTRIP_HOST
386         depends on !BR2_PACKAGE_HOST_ELF2FLT
387         depends on BR2_DEPRECATED_SINCE_2014_05
388         help
389           Binaries and libraries in the target filesystem will be
390           stripped using the 'sstrip' command, which strips a little
391           bit more than the traditional 'strip' command. This allows to
392           save space, mainly by removing debugging symbols. Debugging
393           symbols on the target are needed for native debugging, but
394           not when remote debugging is used.
396 config BR2_STRIP_none
397         bool "none"
398         help
399           Do not strip binaries and libraries in the target
400           filesystem.
401 endchoice
403 config BR2_STRIP_EXCLUDE_FILES
404         string "executables that should not be stripped"
405         depends on !BR2_STRIP_none
406         default ""
407         help
408           You may specify a space-separated list of binaries and libraries
409           here that should not be stripped on the target.
411 config BR2_STRIP_EXCLUDE_DIRS
412         string "directories that should be skipped when stripping"
413         depends on !BR2_STRIP_none
414         default ""
415         help
416           You may specify a space-separated list of directories that should
417           be skipped when stripping. Binaries and libraries in these
418           directories will not be touched.
419           The directories should be specified relative to the target directory,
420           without leading slash.
422 choice
423         prompt "gcc optimization level"
424         default BR2_OPTIMIZE_S
425         help
426           Set the optimization level for gcc
428 config BR2_OPTIMIZE_0
429         bool "optimization level 0"
430         help
431           Do not optimize. This is the default.
433 config BR2_OPTIMIZE_1
434         bool "optimization level 1"
435         help
436           Optimize. Optimizing compilation takes somewhat more time,
437           and a lot more memory for a large function. With -O, the
438           compiler tries to reduce code size and execution time,
439           without performing any optimizations that take a great deal
440           of compilation time. -O turns on the following optimization
441           flags: -fdefer-pop -fdelayed-branch -fguess-branch-probability
442           -fcprop-registers -floop-optimize -fif-conversion
443           -fif-conversion2 -ftree-ccp -ftree-dce -ftree-dominator-opts
444           -ftree-dse -ftree-ter -ftree-lrs -ftree-sra -ftree-copyrename
445           -ftree-fre -ftree-ch -funit-at-a-time -fmerge-constants
446           -O also turns on -fomit-frame-pointer on machines where doing
447           so does not interfere with debugging.
449 config BR2_OPTIMIZE_2
450         bool "optimization level 2"
451         help
452           Optimize even more. GCC performs nearly all supported optimizations
453           that do not involve a space-speed tradeoff. The compiler does not
454           perform loop unrolling or function inlining when you specify -O2.
455           As compared to -O, this option increases both compilation time and
456           the performance of the generated code. -O2 turns on all optimization
457           flags specified by -O. It also turns on the following optimization
458           flags: -fthread-jumps -fcrossjumping -foptimize-sibling-calls
459           -fcse-follow-jumps -fcse-skip-blocks -fgcse  -fgcse-lm
460           -fexpensive-optimizations -fstrength-reduce -frerun-cse-after-loop
461           -frerun-loop-opt -fcaller-saves -fpeephole2 -fschedule-insns
462           -fschedule-insns2 -fsched-interblock -fsched-spec -fregmove
463           -fstrict-aliasing -fdelete-null-pointer-checks -freorder-blocks
464           -freorder-functions -falign-functions -falign-jumps -falign-loops
465           -falign-labels -ftree-vrp -ftree-pre
466           Please note the warning under -fgcse about invoking -O2 on programs
467           that use computed gotos.
469 config BR2_OPTIMIZE_3
470         bool "optimization level 3"
471         help
472           Optimize yet more. -O3 turns on all optimizations specified by -O2
473           and also turns on the -finline-functions, -funswitch-loops and
474           -fgcse-after-reload options.
476 config BR2_OPTIMIZE_S
477         bool "optimize for size"
478         help
479           Optimize for size. -Os enables all -O2 optimizations that do not
480           typically increase code size. It also performs further optimizations
481           designed to reduce code size. -Os disables the following optimization
482           flags: -falign-functions -falign-jumps -falign-loops -falign-labels
483           -freorder-blocks -freorder-blocks-and-partition -fprefetch-loop-arrays
484           -ftree-vect-loop-version
486 endchoice
488 config BR2_GOOGLE_BREAKPAD_ENABLE
489         bool "Enable google-breakpad support"
490         select BR2_PACKAGE_GOOGLE_BREAKPAD
491         depends on BR2_INSTALL_LIBSTDCPP
492         depends on BR2_TOOLCHAIN_USES_GLIBC
493         depends on BR2_PACKAGE_GOOGLE_BREAKPAD_ARCH_SUPPORTS
494         help
495           This option will enable the use of google breakpad, a
496           library and tool suite that allows you to distribute an
497           application to users with compiler-provided debugging
498           information removed, record crashes in compact "minidump"
499           files, send them back to your server and produce C and C++
500           stack traces from these minidumps.  Breakpad can also write
501           minidumps on request for programs that have not crashed.
503 if BR2_GOOGLE_BREAKPAD_ENABLE
505 config BR2_GOOGLE_BREAKPAD_INCLUDE_FILES
506         string "List of executables and libraries to extract symbols from"
507         default ""
508         help
509           You may specify a space-separated list of binaries and
510           libraries with full paths relative to $(TARGET_DIR) of which
511           debug symbols will be dumped for further use with google
512           breakpad.
514           A directory structure that can be used by minidump-stackwalk
515           will be created at:
517           $(STAGING_DIR)/usr/share/google-breakpad-symbols
519 endif
521 config BR2_ENABLE_SSP
522         bool "build code with Stack Smashing Protection"
523         depends on BR2_TOOLCHAIN_HAS_SSP
524         help
525           Enable stack smashing protection support using GCCs
526           -fstack-protector-all option.
528           See http://www.linuxfromscratch.org/hints/downloads/files/ssp.txt
529           for details.
531           Note that this requires the toolchain to have SSP
532           support. This is always the case for glibc and eglibc
533           toolchain, but is optional in uClibc toolchains.
535 comment "enabling Stack Smashing Protection requires support in the toolchain"
536         depends on !BR2_TOOLCHAIN_HAS_SSP
538 config BR2_PREFER_STATIC_LIB
539         bool "prefer static libraries"
540         help
541           Where possible, build and use static libraries for the target.
542           This potentially increases your code size and should only be
543           used if you know what you do.
544           The default is to build dynamic libraries and use those on
545           the target filesystem.
547           WARNING: This is highly experimental at the moment.
549 config BR2_PACKAGE_OVERRIDE_FILE
550         string "location of a package override file"
551         default "$(CONFIG_DIR)/local.mk"
552         help
553           A package override file is a short makefile that contains
554           variable definitions of the form <pkg>_OVERRIDE_SRCDIR,
555           which allows to tell Buildroot to use an existing directory
556           as the source directory for a particular package. See the
557           Buildroot documentation for more details on this feature.
559 config BR2_GLOBAL_PATCH_DIR
560         string "global patch directories"
561         help
562           You may specify a space separated list of one or more directories
563           containing global package patches. For a specific version
564           <packageversion> of a specific package <packagename>, patches are
565           applied as follows:
567           First, the default Buildroot patch set for the package is applied
568           from the package's directory in Buildroot.
570           Then for every directory - <global-patch-dir> - that exists in
571           BR2_GLOBAL_PATCH_DIR, if the directory
572           <global-patch-dir>/<packagename>/<packageversion>/ exists, then all
573           *.patch files in this directory will be applied.
575           Otherwise, if the directory <global-patch-dir>/<packagename> exists,
576           then all *.patch files in the directory will be applied.
578 endmenu
580 source "toolchain/Config.in"
582 source "system/Config.in"
584 source "linux/Config.in"
586 source "package/Config.in"
588 source "fs/Config.in"
590 source "boot/Config.in"
592 source "package/Config.in.host"
594 source "Config.in.legacy"
596 menu "User-provided options"
597         depends on BR2_EXTERNAL != "support/dummy-external"
599 source "$BR2_EXTERNAL/Config.in"
601 endmenu