config: trim/improve item names and help texts.

Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
This commit is contained in:
Denys Vlasenko 2017-07-27 02:59:13 +02:00
parent 488e609203
commit 86d5bf4246
2 changed files with 48 additions and 53 deletions

View File

@ -3,13 +3,13 @@
# see scripts/kbuild/config-language.txt. # see scripts/kbuild/config-language.txt.
# #
mainmenu "BusyBox Configuration" mainmenu "Configuration"
config HAVE_DOT_CONFIG config HAVE_DOT_CONFIG
bool bool
default y default y
menu "Busybox Settings" menu "Settings"
config DESKTOP config DESKTOP
bool "Enable compatibility for full-blown desktop systems" bool "Enable compatibility for full-blown desktop systems"
@ -57,7 +57,7 @@ config SHOW_USAGE
bool "Show applet usage messages" bool "Show applet usage messages"
default y default y
help help
Enabling this option, BusyBox applets will show terse help messages Enabling this option, applets will show terse help messages
when invoked with wrong arguments. when invoked with wrong arguments.
If you do not want to show any (helpful) usage message when If you do not want to show any (helpful) usage message when
issuing wrong command syntax, you can say 'N' here, issuing wrong command syntax, you can say 'N' here,
@ -68,18 +68,16 @@ config FEATURE_VERBOSE_USAGE
default y default y
depends on SHOW_USAGE depends on SHOW_USAGE
help help
All BusyBox applets will show verbose help messages when All applets will show verbose help messages when invoked with --help.
busybox is invoked with --help. This will add a lot of text to the This will add a lot of text to the binary.
busybox binary. In the default configuration, this will add about
13k, but it can add much more depending on your configuration.
config FEATURE_COMPRESS_USAGE config FEATURE_COMPRESS_USAGE
bool "Store applet usage messages in compressed form" bool "Store applet usage messages in compressed form"
default y default y
depends on SHOW_USAGE depends on SHOW_USAGE
help help
Store usage messages in .bz compressed form, uncompress them Store usage messages in .bz2 compressed form, uncompress them
on-the-fly when <applet> --help is called. on-the-fly when "APPLET --help" is run.
If you have a really tiny busybox with few applets enabled (and If you have a really tiny busybox with few applets enabled (and
bunzip2 isn't one of them), the overhead of the decompressor might bunzip2 isn't one of them), the overhead of the decompressor might
@ -91,25 +89,24 @@ config LFS
bool "Support files > 2 GB" bool "Support files > 2 GB"
default y default y
help help
If you want to build BusyBox with large file support, then enable If you need to work with large files, enable this option.
this option. This will have no effect if your kernel or your C This will have no effect if your kernel or your C
library lacks large file support for large files. Some of the library lacks large file support for large files. Some of the
programs that can benefit from large file support include dd, gzip, programs that can benefit from large file support include dd, gzip,
cp, mount, tar, and many others. If you want to access files larger cp, mount, tar.
than 2 Gigabytes, enable this option.
config PAM config PAM
bool "Support PAM (Pluggable Authentication Modules)" bool "Support PAM (Pluggable Authentication Modules)"
default n default n
help help
Use PAM in some busybox applets (currently login and httpd) instead Use PAM in some applets (currently login and httpd) instead
of direct access to password database. of direct access to password database.
config FEATURE_DEVPTS config FEATURE_DEVPTS
bool "Use the devpts filesystem for Unix98 PTYs" bool "Use the devpts filesystem for Unix98 PTYs"
default y default y
help help
Enable if you want BusyBox to use Unix98 PTY support. If enabled, Enable if you want to use Unix98 PTY support. If enabled,
busybox will use /dev/ptmx for the master side of the pseudoterminal busybox will use /dev/ptmx for the master side of the pseudoterminal
and /dev/pts/<number> for the slave side. Otherwise, BSD style and /dev/pts/<number> for the slave side. Otherwise, BSD style
/dev/ttyp<number> will be used. To use this option, you should have /dev/ttyp<number> will be used. To use this option, you should have
@ -157,9 +154,9 @@ config BUSYBOX
bool "Include busybox applet" bool "Include busybox applet"
default y default y
help help
The busybox applet provides general help regarding busybox and The busybox applet provides general help message and allows
allows the included applets to be listed. It's also required the included applets to be listed. It also provides
if applet links are to be installed at runtime. If you unselect optional --install command to create applet links. If you unselect
this option, running busybox without any arguments will give this option, running busybox without any arguments will give
just a cryptic error message: just a cryptic error message:
@ -181,7 +178,7 @@ config INSTALL_NO_USR
bool "Don't use /usr" bool "Don't use /usr"
default n default n
help help
Disable use of /usr. busybox --install and "make install" Disable use of /usr. "busybox --install" and "make install"
will install applets only to /bin and /sbin, will install applets only to /bin and /sbin,
never to /usr/bin or /usr/sbin. never to /usr/bin or /usr/sbin.
@ -194,11 +191,11 @@ config FEATURE_SUID
root-level operations even when run by ordinary users root-level operations even when run by ordinary users
(for example, mounting of user mounts in fstab needs this). (for example, mounting of user mounts in fstab needs this).
With this option enabled, Busybox drops privileges for applets With this option enabled, busybox drops privileges for applets
that don't need root access, before entering their main() function. that don't need root access, before entering their main() function.
If you are really paranoid and don't want even initial busybox code If you are really paranoid and don't want even initial busybox code
to run under root for evey applet, build two busybox binaries with to run under root for every applet, build two busybox binaries with
different applets in them (and the appropriate symlinks pointing different applets in them (and the appropriate symlinks pointing
to each binary), and only set the suid bit on the one that needs it. to each binary), and only set the suid bit on the one that needs it.
@ -284,14 +281,14 @@ config FEATURE_PREFER_APPLETS
(command name can be shown as 'exe' for applets started this way). (command name can be shown as 'exe' for applets started this way).
config BUSYBOX_EXEC_PATH config BUSYBOX_EXEC_PATH
string "Path to BusyBox executable" string "Path to busybox executable"
default "/proc/self/exe" default "/proc/self/exe"
help help
When Busybox applets need to run other busybox applets, BusyBox When applets need to run other applets, busybox
sometimes needs to exec() itself. When the /proc filesystem is sometimes needs to exec() itself. When the /proc filesystem is
mounted, /proc/self/exe always points to the currently running mounted, /proc/self/exe always points to the currently running
executable. If you haven't got /proc, set this to wherever you executable. If you haven't got /proc, set this to wherever you
want to run BusyBox from. want to run busybox from.
config SELINUX config SELINUX
bool "Support NSA Security Enhanced Linux" bool "Support NSA Security Enhanced Linux"
@ -354,21 +351,17 @@ config PLATFORM_LINUX
comment 'Build Options' comment 'Build Options'
config STATIC config STATIC
bool "Build BusyBox as a static binary (no shared libs)" bool "Build static binary (no shared libs)"
default n default n
help help
If you want to build a static BusyBox binary, which does not If you want to build a static binary, which does not use
use or require any shared libraries, then enable this option. or require any shared libraries, enable this option.
This can cause BusyBox to be considerably larger, so you should Static binaries are larger, but do not require functioning
leave this option false unless you have a good reason (i.e. dynamic libraries to be present, which is important if used
your target platform does not support shared libraries, or as a system rescue tool.
you are building an initrd which doesn't need anything but
BusyBox, etc).
Most people will leave this set to 'N'.
config PIE config PIE
bool "Build BusyBox as a position independent executable" bool "Build position independent executable"
default n default n
depends on !STATIC depends on !STATIC
help help
@ -466,10 +459,10 @@ config FEATURE_SHARED_BUSYBOX
### Say 'N' unless you know what you are doing. ### Say 'N' unless you know what you are doing.
config CROSS_COMPILER_PREFIX config CROSS_COMPILER_PREFIX
string "Cross Compiler prefix" string "Cross compiler prefix"
default "" default ""
help help
If you want to build BusyBox with a cross compiler, then you If you want to build busybox with a cross compiler, then you
will need to set this to the cross-compiler prefix, for example, will need to set this to the cross-compiler prefix, for example,
"i386-uclibc-". "i386-uclibc-".
@ -482,11 +475,11 @@ config SYSROOT
string "Path to sysroot" string "Path to sysroot"
default "" default ""
help help
If you want to build BusyBox with a cross compiler, then you If you want to build busybox with a cross compiler, then you
might also need to specify where /usr/include and /usr/lib might also need to specify where /usr/include and /usr/lib
will be found. will be found.
For example, BusyBox can be built against an installed For example, busybox can be built against an installed
Android NDK, platform version 9, for ARM ABI with Android NDK, platform version 9, for ARM ABI with
CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
@ -580,21 +573,22 @@ config INSTALL_SH_APPLET_SCRIPT_WRAPPER
endchoice endchoice
config PREFIX config PREFIX
string "BusyBox installation prefix" string "Destination path for 'make install'"
default "./_install" default "./_install"
help help
Define your directory to install BusyBox files/subdirs in. Where "make install" should install busybox binary and links.
comment 'Debugging Options' comment 'Debugging Options'
config DEBUG config DEBUG
bool "Build BusyBox with extra Debugging symbols" bool "Build with debug information"
default n default n
help help
Say Y here if you wish to examine BusyBox internals while applets are Say Y here to compile with debug information.
running. This increases the size of the binary considerably, and This increases the size of the binary considerably, and
should only be used when doing development. If you are doing should only be used when doing development.
development and want to debug BusyBox, answer Y.
This adds -g option to gcc command line.
Most people should answer N. Most people should answer N.
@ -609,6 +603,8 @@ config DEBUG_PESSIMIZE
in a much bigger executable that more closely matches the source in a much bigger executable that more closely matches the source
code. code.
This replaces -Os/-O2 with -O0 in gcc command line.
config DEBUG_SANITIZE config DEBUG_SANITIZE
bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)" bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
default n default n
@ -626,7 +622,7 @@ config UNIT_TEST
default n default n
help help
Say Y here if you want to build unit tests (both the framework and Say Y here if you want to build unit tests (both the framework and
test cases) as a Busybox applet. This results in bigger code, so you test cases) as an applet. This results in bigger code, so you
probably don't want this option in production builds. probably don't want this option in production builds.
config WERROR config WERROR
@ -641,8 +637,8 @@ choice
prompt "Additional debugging library" prompt "Additional debugging library"
default NO_DEBUG_LIB default NO_DEBUG_LIB
help help
Using an additional debugging library will make BusyBox become Using an additional debugging library will make busybox become
considerable larger and will cause it to run more slowly. You considerably larger and will cause it to run more slowly. You
should always leave this option disabled for production use. should always leave this option disabled for production use.
dmalloc support: dmalloc support:
@ -663,7 +659,7 @@ choice
This enables compiling with Electric-fence support. Electric This enables compiling with Electric-fence support. Electric
fence is another very useful malloc debugging library which uses fence is another very useful malloc debugging library which uses
your computer's virtual memory hardware to detect illegal memory your computer's virtual memory hardware to detect illegal memory
accesses. This support will make BusyBox be considerable larger accesses. This support will make busybox be considerably larger
and run slower, so you should leave this option disabled unless and run slower, so you should leave this option disabled unless
you are hunting a hard to find memory problem. you are hunting a hard to find memory problem.

View File

@ -11,14 +11,13 @@ choice
prompt "Buffer allocation policy" prompt "Buffer allocation policy"
default FEATURE_BUFFERS_USE_MALLOC default FEATURE_BUFFERS_USE_MALLOC
help help
There are 3 ways BusyBox can handle buffer allocations: There are 3 ways busybox can handle buffer allocations:
- Use malloc. This costs code size for the call to xmalloc. - Use malloc. This costs code size for the call to xmalloc.
- Put them on stack. For some very small machines with limited stack - Put them on stack. For some very small machines with limited stack
space, this can be deadly. For most folks, this works just fine. space, this can be deadly. For most folks, this works just fine.
- Put them in BSS. This works beautifully for computers with a real - Put them in BSS. This works beautifully for computers with a real
MMU (and OS support), but wastes runtime RAM for uCLinux. This MMU (and OS support), but wastes runtime RAM for uCLinux. This
behavior was the only one available for BusyBox versions 0.48 and behavior was the only one available for versions 0.48 and earlier.
earlier.
config FEATURE_BUFFERS_USE_MALLOC config FEATURE_BUFFERS_USE_MALLOC
bool "Allocate with Malloc" bool "Allocate with Malloc"