aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Andersen <andersen@codepoet.org>2002-12-05 21:12:42 +0000
committerEric Andersen <andersen@codepoet.org>2002-12-05 21:12:42 +0000
commit536018278af5d14f573e7ffa3b21dac026a646dd (patch)
treee815f060548d74adcf5c2bf0aab6e576d04256f3
parentf0a360ea1959f93177bbf7938354fa7148fed667 (diff)
downloadbusybox-w32-536018278af5d14f573e7ffa3b21dac026a646dd.tar.gz
busybox-w32-536018278af5d14f573e7ffa3b21dac026a646dd.tar.bz2
busybox-w32-536018278af5d14f573e7ffa3b21dac026a646dd.zip
Kill the now obsolete docs/Configure.help file, and move all existing
help texts into their respective Config.in file. -Erik
-rw-r--r--archival/Config.in24
-rw-r--r--debianutils/Config.in11
-rw-r--r--docs/Configure.help133
-rw-r--r--sysdeps/linux/Config.in36
4 files changed, 61 insertions, 143 deletions
diff --git a/archival/Config.in b/archival/Config.in
index ecef07f7c..121cf0282 100644
--- a/archival/Config.in
+++ b/archival/Config.in
@@ -9,7 +9,17 @@ config CONFIG_AR
9 bool "ar" 9 bool "ar"
10 default n 10 default n
11 help 11 help
12 Please submit a patch to add help text for this item. 12 ar is an archival utility program used to create, modify, and
13 extract contents from archives. An archive is a single file holding
14 a collection of other files in a structure that makes it possible to
15 retrieve the original individual files (called archive members).
16 The original files' contents, mode (permissions), timestamp, owner,
17 and group are preserved in the archive, and can be restored on
18 extraction.
19 On an x86 system, the ar applet adds about XXX bytes.
20
21 Unless you have a specific application which requires ar, you should
22 probably say N here.
13 23
14config CONFIG_FEATURE_AR_LONG_FILENAMES 24config CONFIG_FEATURE_AR_LONG_FILENAMES
15 bool " Enable support for long filenames (not need for debs)" 25 bool " Enable support for long filenames (not need for debs)"
@@ -22,7 +32,17 @@ config CONFIG_BUNZIP2
22 bool "bunzip2" 32 bool "bunzip2"
23 default n 33 default n
24 help 34 help
25 Please submit a patch to add help text for this item. 35 bunzip2 is an compression utility using the Burrows-Wheeler block
36 sorting text compression algorithm, and Huffman coding. Compression
37 is generally considerably better than that achieved by more
38 conventional LZ77/LZ78-based compressors, and approaches the
39 performance of the PPM family of statistical compressors.
40
41 The BusyBox bunzip2 applet is limited to de-compression only. On an
42 x86 system, this applet adds about XXX bytes.
43
44 Unless you have a specific application which requires bunzip2, you
45 should probably say N here.
26 46
27config CONFIG_CPIO 47config CONFIG_CPIO
28 bool "cpio" 48 bool "cpio"
diff --git a/debianutils/Config.in b/debianutils/Config.in
index 9f6d840cf..210c43e79 100644
--- a/debianutils/Config.in
+++ b/debianutils/Config.in
@@ -21,7 +21,16 @@ config CONFIG_RUN_PARTS
21 bool "run-parts" 21 bool "run-parts"
22 default n 22 default n
23 help 23 help
24 Please submit a patch to add help text for this item. 24 run-parts is an utility designed to run all the scripts in a directory.
25
26 It is useful to set up a directory like cron.daily, where you need to
27 execute all the scripts in that directory.
28
29 This implementation of run-parts doesn't accept long options, and
30 some features (like report mode) aren't implemented.
31
32 Unless you know that run-parts is used in some of your scripts
33 you can safely say N here.
25 34
26config CONFIG_WHICH 35config CONFIG_WHICH
27 bool "which" 36 bool "which"
diff --git a/docs/Configure.help b/docs/Configure.help
deleted file mode 100644
index 53cebd578..000000000
--- a/docs/Configure.help
+++ /dev/null
@@ -1,133 +0,0 @@
1# BusyBox configuration option Help File
2#
3# Format of this file: description<nl>variable<nl>help text<nl><nl>.
4# The help texts may contain empty lines, but every non-empty line must
5# be indented two positions. Order of the help texts does not matter,
6# however, no variable should be documented twice: if it is, only the
7# first occurrence will be used. We try to keep the help texts of related
8# variables close together. Lines starting with `#' are ignored. To be
9# nice to menuconfig, limit your line length to 70 characters.
10#
11# Comments of the form "# Choice:" followed by a menu name are used
12# internally by the maintainers' consistency-checking tools.
13#
14# If you add a help text to this file, please try to be as gentle as
15# possible. Don't use unexplained acronyms and generally write for the
16# hypothetical ignorant but intelligent user who has just bought a PC,
17# removed Windows, installed Linux and is now compiling up BusyBox
18# for the first time. Tell them what to do if they're unsure.
19#
20# Mention all the relevant READMEs and HOWTOs in the help text.
21# Make them file URLs relative to the top level of the source tree so
22# that help browsers can turn them into hotlinks. All URLs ahould be
23# surrounded by <>.
24#
25# Repetitions are fine since the help texts are not meant to be read
26# in sequence. It is good style to include URLs pointing to more
27# detailed technical information, pictures of the hardware, etc.
28#
29# The most important thing to include in a help entry is *motivation*.
30# Explain why someone configuring BusyBox might want to select your
31# option.
32#
33
34Show verbose applets usage message
35CONFIG_FEATURE_VERBOSE_USAGE
36 All BusyBox applets will show more verbose help messages when
37 busybox is invoked with --help. This will add lots of text to the
38 busybox binary. In the default configuration, this will add about
39 13k, but it can add much more depending on your configuration.
40
41Enable automatic symlink creation for BusyBox built-in applets
42CONFIG_FEATURE_INSTALLER
43 Enable 'busybox --install [-s]' support. This will allow you to use
44 busybox at runtime to create hard links or symlinks for all the
45 applets that are compiled into busybox. This feature requires the
46 /proc filesystem.
47
48Locale support
49CONFIG_LOCALE_SUPPORT
50 Enable this if your system has locale support, and you would like
51 busybox to support locale settings.
52
53Enable devfs support
54CONFIG_FEATURE_DEVFS
55 Enable if you want BusyBox to work with devfs.
56
57Enable devfs support
58CONFIG_FEATURE_DEVPTS
59 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
60 busybox will use /dev/ptmx for the master side of the pseudoterminal
61 and /dev/pts/<number> for the slave side. Otherwise, BSD style
62 /dev/ttyp<number> will be used. To use this option, you should have
63 devpts or devfs mounted.
64
65Clean up all memory before exiting
66CONFIG_FEATURE_CLEAN_UP
67 As a size optimization, busybox by default does not cleanup memory
68 that is dynamically allocated or close files before exiting. This
69 saves space and is usually not needed since the OS will clean up for
70 us. Don't enable this unless you have a really good reason to clean
71 things up manually.
72
73Buffers allocation policy
74CONFIG_FEATURE_BUFFERS_USE_MALLOC
75 There are 3 ways BusyBox can handle buffer allocations:
76 - Use malloc. This costs code size for the call to xmalloc.
77 - Put them on stack. For some very small machines with limited stack
78 space, this can be deadly. For most folks, this works just fine.
79 - Put them in BSS. This works beautifully for computers with a real
80 MMU (and OS support), but wastes runtime RAM for uCLinux. This
81 behavior was the only one available for BusyBox versions 0.48 and
82 earlier.
83
84Enable the ar applet
85CONFIG_AR
86 ar is an archival utility program used to create, modify, and
87 extract contents from archives. An archive is a single file holding
88 a collection of other files in a structure that makes it possible to
89 retrieve the original individual files (called archive members).
90 The original files' contents, mode (permissions), timestamp, owner,
91 and group are preserved in the archive, and can be restored on
92 extraction.
93 On an x86 system, the ar applet adds about XXX bytes.
94
95 Unless you have a specific application which requires ar, you should
96 probably say N here.
97
98Enable the bunzip2 applet
99CONFIG_BUNZIP2
100 bunzip2 is an compression utility using the Burrows-Wheeler block
101 sorting text compression algorithm, and Huffman coding. Compression
102 is generally considerably better than that achieved by more
103 conventional LZ77/LZ78-based compressors, and approaches the
104 performance of the PPM family of statistical compressors.
105
106 The BusyBox bunzip2 applet is limited to de-compression only. On an
107 x86 system, this applet adds about XXX bytes.
108
109 Unless you have a specific application which requires bunzip2, you
110 should probably say N here.
111
112# FIXME -- document the rest of the BusyBox config options....
113
114Enable the run-parts applet
115CONFIG_RUN_PARTS
116 run-parts is an utility designed to run all the scripts in a directory.
117
118 It is useful to set up a directory like cron.daily, where you need to
119 execute all the scripts in that directory.
120
121 This implementation of run-parts doesn't accept long options, and
122 some features (like report mode) aren't implemented.
123
124 Unless you know that run-parts is used in some of your scripts
125 you can safely say N here.
126
127# The following sets edit modes for GNU EMACS
128# Local Variables:
129# case-fold-search:nil
130# fill-prefix:" "
131# adaptive-fill:nil
132# fill-column:70
133# End:
diff --git a/sysdeps/linux/Config.in b/sysdeps/linux/Config.in
index 0fa66eac6..e3bdc4062 100644
--- a/sysdeps/linux/Config.in
+++ b/sysdeps/linux/Config.in
@@ -9,7 +9,14 @@ choice
9 prompt "Buffer allocation policy" 9 prompt "Buffer allocation policy"
10 default "Allocate with Malloc" 10 default "Allocate with Malloc"
11 help 11 help
12 Please submit a patch to add help text for this item. 12 There are 3 ways BusyBox can handle buffer allocations:
13 - Use malloc. This costs code size for the call to xmalloc.
14 - Put them on stack. For some very small machines with limited stack
15 space, this can be deadly. For most folks, this works just fine.
16 - Put them in BSS. This works beautifully for computers with a real
17 MMU (and OS support), but wastes runtime RAM for uCLinux. This
18 behavior was the only one available for BusyBox versions 0.48 and
19 earlier.
13 20
14config CONFIG_FEATURE_BUFFERS_USE_MALLOC 21config CONFIG_FEATURE_BUFFERS_USE_MALLOC
15 bool "Allocate with Malloc" 22 bool "Allocate with Malloc"
@@ -26,37 +33,52 @@ config CONFIG_FEATURE_VERBOSE_USAGE
26 bool "Show verbose applet usage messages" 33 bool "Show verbose applet usage messages"
27 default n 34 default n
28 help 35 help
29 Please submit a patch to add help text for this item. 36 All BusyBox applets will show more verbose help messages when
37 busybox is invoked with --help. This will add lots of text to the
38 busybox binary. In the default configuration, this will add about
39 13k, but it can add much more depending on your configuration.
30 40
31config CONFIG_FEATURE_INSTALLER 41config CONFIG_FEATURE_INSTALLER
32 bool "Support --install [-s] to install applet links at runtime" 42 bool "Support --install [-s] to install applet links at runtime"
33 default n 43 default n
34 help 44 help
35 Please submit a patch to add help text for this item. 45 Enable 'busybox --install [-s]' support. This will allow you to use
46 busybox at runtime to create hard links or symlinks for all the
47 applets that are compiled into busybox. This feature requires the
48 /proc filesystem.
36 49
37config CONFIG_LOCALE_SUPPORT 50config CONFIG_LOCALE_SUPPORT
38 bool "Enable locale support (system needs locale for this to work)" 51 bool "Enable locale support (system needs locale for this to work)"
39 default n 52 default n
40 help 53 help
41 Please submit a patch to add help text for this item. 54 Enable this if your system has locale support, and you would like
55 busybox to support locale settings.
42 56
43config CONFIG_FEATURE_DEVFS 57config CONFIG_FEATURE_DEVFS
44 bool "Support for devfs" 58 bool "Support for devfs"
45 default n 59 default n
46 help 60 help
47 Please submit a patch to add help text for this item. 61 Enable if you want BusyBox to work with devfs.
48 62
49config CONFIG_FEATURE_DEVPTS 63config CONFIG_FEATURE_DEVPTS
50 bool "Use the devpts filesystem for Unix98 PTYs" 64 bool "Use the devpts filesystem for Unix98 PTYs"
51 default y if CONFIG_FEATURE_DEVFS 65 default y if CONFIG_FEATURE_DEVFS
52 help 66 help
53 Please submit a patch to add help text for this item. 67 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
68 busybox will use /dev/ptmx for the master side of the pseudoterminal
69 and /dev/pts/<number> for the slave side. Otherwise, BSD style
70 /dev/ttyp<number> will be used. To use this option, you should have
71 devpts or devfs mounted.
54 72
55config CONFIG_FEATURE_CLEAN_UP 73config CONFIG_FEATURE_CLEAN_UP
56 bool "Clean up all memory before exiting (usually not needed)" 74 bool "Clean up all memory before exiting (usually not needed)"
57 default n 75 default n
58 help 76 help
59 Please submit a patch to add help text for this item. 77 As a size optimization, busybox by default does not cleanup memory
78 that is dynamically allocated or close files before exiting. This
79 saves space and is usually not needed since the OS will clean up for
80 us. Don't enable this unless you have a really good reason to clean
81 things up manually.
60 82
61config CONFIG_FEATURE_SUID 83config CONFIG_FEATURE_SUID
62 bool "Support for SUID/SGID handling" 84 bool "Support for SUID/SGID handling"