From 68b653b66b0db6b1554806650fb0bebd7af9ef3b Mon Sep 17 00:00:00 2001 From: Denys Vlasenko Date: Thu, 27 Jul 2017 10:53:09 +0200 Subject: [PATCH] config: trim/improve item names and help texts, take 2 Signed-off-by: Denys Vlasenko --- editors/awk.c | 3 +- loginutils/login.c | 2 +- loginutils/passwd.c | 2 +- loginutils/vlock.c | 2 +- miscutils/crontab.c | 2 +- networking/ftpd.c | 13 ++++-- networking/ifupdown.c | 4 +- networking/ip.c | 18 +++++---- networking/telnetd.c | 2 +- networking/tftp.c | 16 ++++---- networking/udhcp/Config.src | 80 +++++++++++++++++++------------------ networking/udhcp/d6_dhcpc.c | 2 +- util-linux/blkid.c | 2 - util-linux/findfs.c | 2 - util-linux/mdev.c | 2 +- util-linux/mount.c | 3 +- 16 files changed, 81 insertions(+), 74 deletions(-) diff --git a/editors/awk.c b/editors/awk.c index aa927db1a..cc17ad438 100644 --- a/editors/awk.c +++ b/editors/awk.c @@ -11,8 +11,7 @@ //config: bool "awk (22 kb)" //config: default y //config: help -//config: Awk is used as a pattern scanning and processing language. This is -//config: the BusyBox implementation of that programming language. +//config: Awk is used as a pattern scanning and processing language. //config: //config:config FEATURE_AWK_LIBM //config: bool "Enable math functions (requires libm)" diff --git a/loginutils/login.c b/loginutils/login.c index 39f703f07..381468d81 100644 --- a/loginutils/login.c +++ b/loginutils/login.c @@ -9,7 +9,7 @@ //config: help //config: login is used when signing onto a system. //config: -//config: Note that Busybox binary must be setuid root for this applet to +//config: Note that busybox binary must be setuid root for this applet to //config: work properly. //config: //config:config LOGIN_SESSION_AS_CHILD diff --git a/loginutils/passwd.c b/loginutils/passwd.c index 03f8ad0a4..3e1ef9abf 100644 --- a/loginutils/passwd.c +++ b/loginutils/passwd.c @@ -12,7 +12,7 @@ //config: may change the password for any account. The administrator of a group //config: may change the password for the group. //config: -//config: Note that Busybox binary must be setuid root for this applet to +//config: Note that busybox binary must be setuid root for this applet to //config: work properly. //config: //config:config FEATURE_PASSWD_WEAK_CHECK diff --git a/loginutils/vlock.c b/loginutils/vlock.c index f22abd3aa..bf46d085c 100644 --- a/loginutils/vlock.c +++ b/loginutils/vlock.c @@ -21,7 +21,7 @@ //config: help //config: Build the "vlock" applet which allows you to lock (virtual) terminals. //config: -//config: Note that Busybox binary must be setuid root for this applet to +//config: Note that busybox binary must be setuid root for this applet to //config: work properly. //applet:/* Needs to be run by root or be suid root - needs to change uid and gid: */ diff --git a/miscutils/crontab.c b/miscutils/crontab.c index 23cb54887..804cb57f2 100644 --- a/miscutils/crontab.c +++ b/miscutils/crontab.c @@ -15,7 +15,7 @@ //config: help //config: Crontab manipulates the crontab for a particular user. Only //config: the superuser may specify a different user and/or crontab directory. -//config: Note that Busybox binary must be setuid root for this applet to +//config: Note that busybox binary must be setuid root for this applet to //config: work properly. /* Needs to be run by root or be suid root - needs to change /var/spool/cron* files: */ diff --git a/networking/ftpd.c b/networking/ftpd.c index aee00e1c3..c562c2886 100644 --- a/networking/ftpd.c +++ b/networking/ftpd.c @@ -18,11 +18,12 @@ //config: Simple FTP daemon. You have to run it via inetd. //config: //config:config FEATURE_FTPD_WRITE -//config: bool "Enable upload commands" +//config: bool "Enable -w (upload commands)" //config: default y //config: depends on FTPD //config: help -//config: Enable all kinds of FTP upload commands (-w option) +//config: Enable -w option. "ftpd -w" will accept upload commands +//config: such as STOR, STOU, APPE, DELE, MKD, RMD, rename commands. //config: //config:config FEATURE_FTPD_ACCEPT_BROKEN_LIST //config: bool "Enable workaround for RFC-violating clients" @@ -40,7 +41,13 @@ //config: default y //config: depends on FTPD //config: help -//config: Enable basic system login as seen in telnet etc. +//config: Require login, and change to logged in user's UID:GID before +//config: accessing any files. Option "-a USER" allows "anonymous" +//config: logins (treats them as if USER logged in). +//config: +//config: If this option is not selected, ftpd runs with the rights +//config: of the user it was started under, and does not require login. +//config: Take care to not launch it under root. //applet:IF_FTPD(APPLET(ftpd, BB_DIR_USR_SBIN, BB_SUID_DROP)) diff --git a/networking/ifupdown.c b/networking/ifupdown.c index f8c29ab00..c2cfe82ec 100644 --- a/networking/ifupdown.c +++ b/networking/ifupdown.c @@ -59,11 +59,11 @@ //config: than the default of using the older "ifconfig" and "route" utilities. //config: //config: If Y: you must install either the full-blown iproute2 package -//config: or enable "ip" applet in Busybox, or the "ifup" and "ifdown" applets +//config: or enable "ip" applet in busybox, or the "ifup" and "ifdown" applets //config: will not work. //config: //config: If N: you must install either the full-blown ifconfig and route -//config: utilities, or enable these applets in Busybox. +//config: utilities, or enable these applets in busybox. //config: //config:config FEATURE_IFUPDOWN_IPV4 //config: bool "Support IPv4" diff --git a/networking/ip.c b/networking/ip.c index cca7cbe12..8aaeef0db 100644 --- a/networking/ip.c +++ b/networking/ip.c @@ -14,8 +14,10 @@ //config: select PLATFORM_LINUX //config: help //config: The "ip" applet is a TCP/IP interface configuration and routing -//config: utility. You generally don't need "ip" to use busybox with -//config: TCP/IP. +//config: utility. +//config: Short forms (enabled below) are busybox-specific extensions. +//config: The standard "ip" utility does not provide them. If you are +//config: trying to be portable, it's better to use "ip CMD" forms. //config: //config:config IPADDR //config: bool "ipaddr (14 kb)" @@ -23,7 +25,7 @@ //config: select FEATURE_IP_ADDRESS //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip addr: ipaddr +//config: Short form of "ip addr" //config: //config:config IPLINK //config: bool "iplink (16 kb)" @@ -31,7 +33,7 @@ //config: select FEATURE_IP_LINK //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip link: iplink +//config: Short form of "ip link" //config: //config:config IPROUTE //config: bool "iproute (15 kb)" @@ -39,7 +41,7 @@ //config: select FEATURE_IP_ROUTE //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip route: iproute +//config: Short form of "ip route" //config: //config:config IPTUNNEL //config: bool "iptunnel (9.6 kb)" @@ -47,7 +49,7 @@ //config: select FEATURE_IP_TUNNEL //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip tunnel: iptunnel +//config: Short form of "ip tunnel" //config: //config:config IPRULE //config: bool "iprule (10 kb)" @@ -55,7 +57,7 @@ //config: select FEATURE_IP_RULE //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip rule: iprule +//config: Short form of "ip rule" //config: //config:config IPNEIGH //config: bool "ipneigh (8.3 kb)" @@ -63,7 +65,7 @@ //config: select FEATURE_IP_NEIGH //config: select PLATFORM_LINUX //config: help -//config: Support short form of ip neigh: ipneigh +//config: Short form of "ip neigh" //config: //config:config FEATURE_IP_ADDRESS //config: bool "ip address" diff --git a/networking/telnetd.c b/networking/telnetd.c index 6e12de07a..16c572e8d 100644 --- a/networking/telnetd.c +++ b/networking/telnetd.c @@ -54,7 +54,7 @@ //config: //config: You need to be sure that busybox has LOGIN and //config: FEATURE_SUID enabled. And finally, you should make -//config: certain that Busybox has been installed setuid root: +//config: certain that busybox has been installed setuid root: //config: //config: chown root.root /bin/busybox //config: chmod 4755 /bin/busybox diff --git a/networking/tftp.c b/networking/tftp.c index 947e65169..5baa80448 100644 --- a/networking/tftp.c +++ b/networking/tftp.c @@ -22,15 +22,20 @@ //config: bool "tftp (12 kb)" //config: default y //config: help -//config: This enables the Trivial File Transfer Protocol client program. TFTP -//config: is usually used for simple, small transfers such as a root image +//config: Trivial File Transfer Protocol client. TFTP is usually used +//config: for simple, small transfers such as a root image //config: for a network-enabled bootloader. //config: +//config:config FEATURE_TFTP_PROGRESS_BAR +//config: bool "Enable progress bar" +//config: default y +//config: depends on TFTP +//config: //config:config TFTPD //config: bool "tftpd (10 kb)" //config: default y //config: help -//config: This enables the Trivial File Transfer Protocol server program. +//config: Trivial File Transfer Protocol server. //config: It expects that stdin is a datagram socket and a packet //config: is already pending on it. It will exit after one transfer. //config: In other words: it should be run from inetd in nowait mode, @@ -68,11 +73,6 @@ //config: Allow tftp to specify block size, and tftpd to understand //config: "blksize" and "tsize" options. //config: -//config:config FEATURE_TFTP_PROGRESS_BAR -//config: bool "Enable progress bar" -//config: default y -//config: depends on TFTP && FEATURE_TFTP_BLOCKSIZE -//config: //config:config TFTP_DEBUG //config: bool "Enable debug" //config: default n diff --git a/networking/udhcp/Config.src b/networking/udhcp/Config.src index af2fe1835..8ab8d30ce 100644 --- a/networking/udhcp/Config.src +++ b/networking/udhcp/Config.src @@ -3,26 +3,14 @@ # see scripts/kbuild/config-language.txt. # -INSERT - config UDHCPD - bool "udhcpd (DHCP server)" + bool "udhcpd" default y select PLATFORM_LINUX help udhcpd is a DHCP server geared primarily toward embedded systems, while striving to be fully functional and RFC compliant. -config FEATURE_UDHCPD_WRITE_LEASES_EARLY - bool "Rewrite the lease file at every new acknowledge" - default y - depends on UDHCPD - help - If selected, udhcpd will write a new file with leases every - time a new lease has been accepted, thus eliminating the need - to send SIGUSR1 for the initial writing or updating. Any timed - rewriting remains undisturbed. - config FEATURE_UDHCPD_BASE_IP_ON_MAC bool "Select IP address based on client MAC" default n @@ -37,6 +25,16 @@ config FEATURE_UDHCPD_BASE_IP_ON_MAC for the same client to (almost always) contain the same IP address. +config FEATURE_UDHCPD_WRITE_LEASES_EARLY + bool "Rewrite lease file at every new acknowledge" + default y + depends on UDHCPD + help + If selected, udhcpd will write a new file with leases every + time a new lease has been accepted, thus eliminating the need + to send SIGUSR1 for the initial writing or updating. Any timed + rewriting remains undisturbed. + config DHCPD_LEASES_FILE string "Absolute path to lease file" default "/var/lib/misc/udhcpd.leases" @@ -57,12 +55,12 @@ config DHCPRELAY bool "dhcprelay (5.8 kb)" default y help - dhcprelay listens for dhcp requests on one or more interfaces - and forwards these requests to a different interface or dhcp + dhcprelay listens for DHCP requests on one or more interfaces + and forwards these requests to a different interface or DHCP server. config UDHCPC - bool "udhcpc (DHCP client)" + bool "udhcpc" default y select PLATFORM_LINUX help @@ -102,19 +100,25 @@ config UDHCPC_DEFAULT_SCRIPT examples/udhcp for a working example. Normally it is safe to leave this untouched. +# udhcpc6 config is inserted here: +INSERT + +comment "Common options for DHCP applets" + depends on UDHCPD || UDHCPC || UDHCPC6 || DHCPRELAY + config FEATURE_UDHCP_PORT bool "Enable '-P port' option for udhcpd and udhcpc" default n - depends on UDHCPD || UDHCPC + depends on UDHCPD || UDHCPC || UDHCPC6 help At the cost of ~300 bytes, enables -P port option. This feature is typically not needed. config UDHCP_DEBUG - int "Maximum verbosity level for udhcp applets (0..9)" + int "Maximum verbosity level (0..9)" default 9 range 0 9 - depends on UDHCPD || UDHCPC || DHCPRELAY + depends on UDHCPD || UDHCPC || UDHCPC6 || DHCPRELAY help Verbosity can be increased with multiple -v options. This option controls how high it can be cranked up. @@ -122,23 +126,6 @@ config UDHCP_DEBUG Bigger values result in bigger code. Levels above 1 are very verbose and useful for debugging only. -config FEATURE_UDHCP_RFC3397 - bool "Support RFC3397 domain search (experimental)" - default y - depends on UDHCPD || UDHCPC - help - If selected, both client and server will support passing of domain - search lists via option 119, specified in RFC 3397, - and SIP servers option 120, specified in RFC 3361. - -config FEATURE_UDHCP_8021Q - bool "Support 802.1Q VLAN parameters" - default y - depends on UDHCPD || UDHCPC - help - If selected, both client and server will support passing of VLAN - ID and priority via options 132 and 133 as per 802.1Q. - config UDHCPC_SLACK_FOR_BUGGY_SERVERS int "DHCP options slack buffer size" default 80 @@ -149,10 +136,10 @@ config UDHCPC_SLACK_FOR_BUGGY_SERVERS field larger than we expect (which might also be considered a buffer overflow attempt). These packets are normally discarded. If circumstances beyond your control force you to support such - servers, this may help. The upper limit (924) makes dhcpc accept + servers, this may help. The upper limit (924) makes udhcpc accept even 1500 byte packets (maximum-sized ethernet packets). - This option does not make dhcp[cd] emit non-standard + This option does not make udhcp[cd] emit non-standard sized packets. Known buggy DHCP servers: @@ -161,3 +148,20 @@ config UDHCPC_SLACK_FOR_BUGGY_SERVERS maximum size of entire IP packet, and sends packets which are 28 bytes too large. Seednet (ISP) VDSL: sends packets 2 bytes too large. + +config FEATURE_UDHCP_RFC3397 + bool "Support RFC 3397 domain search options" + default y + depends on UDHCPD || UDHCPC + help + If selected, both client and server will support passing of domain + search lists via option 119, specified in RFC 3397, + and SIP servers option 120, specified in RFC 3361. + +config FEATURE_UDHCP_8021Q + bool "Support 802.1Q VLAN parameters options" + default y + depends on UDHCPD || UDHCPC + help + If selected, both client and server will support passing of VLAN + ID and priority via options 132 and 133 as per 802.1Q. diff --git a/networking/udhcp/d6_dhcpc.c b/networking/udhcp/d6_dhcpc.c index 5ebd05d01..43081efca 100644 --- a/networking/udhcp/d6_dhcpc.c +++ b/networking/udhcp/d6_dhcpc.c @@ -10,7 +10,7 @@ */ //config:config UDHCPC6 -//config: bool "udhcpc6 (DHCPv6 client, EXPERIMENTAL)" +//config: bool "udhcpc6" //config: default n # not yet ready //config: depends on FEATURE_IPV6 //config: help diff --git a/util-linux/blkid.c b/util-linux/blkid.c index f353cf248..0bd701aae 100644 --- a/util-linux/blkid.c +++ b/util-linux/blkid.c @@ -13,8 +13,6 @@ //config: select VOLUMEID //config: help //config: Lists labels and UUIDs of all filesystems. -//config: WARNING: -//config: With all submodules selected, it will add ~8k to busybox. //config: //config:config FEATURE_BLKID_TYPE //config: bool "Print filesystem type" diff --git a/util-linux/findfs.c b/util-linux/findfs.c index 359da581f..1102eeff5 100644 --- a/util-linux/findfs.c +++ b/util-linux/findfs.c @@ -14,8 +14,6 @@ //config: select VOLUMEID //config: help //config: Prints the name of a filesystem with given label or UUID. -//config: WARNING: -//config: With all submodules selected, it will add ~8k to busybox. /* Benefits from suid root: better access to /dev/BLOCKDEVs: */ //applet:IF_FINDFS(APPLET(findfs, BB_DIR_SBIN, BB_SUID_MAYBE)) diff --git a/util-linux/mdev.c b/util-linux/mdev.c index 23b6f8285..8acc4d21d 100644 --- a/util-linux/mdev.c +++ b/util-linux/mdev.c @@ -56,7 +56,7 @@ //config: For more information, please see docs/mdev.txt //config: //config:config FEATURE_MDEV_LOAD_FIRMWARE -//config: bool "Support loading of firmwares" +//config: bool "Support loading of firmware" //config: default y //config: depends on MDEV //config: help diff --git a/util-linux/mount.c b/util-linux/mount.c index 1a39da2db..823b7c13b 100644 --- a/util-linux/mount.c +++ b/util-linux/mount.c @@ -26,8 +26,7 @@ //config: tree. The 'mount' utility is used to graft a filesystem onto a //config: particular part of the tree. A filesystem can either live on a block //config: device, or it can be accessible over the network, as is the case with -//config: NFS filesystems. Most people using BusyBox will also want to enable -//config: the 'mount' utility. +//config: NFS filesystems. //config: //config:config FEATURE_MOUNT_FAKE //config: bool "Support option -f"