From f1f532084a6e9ee8225f047353999b459455df7e Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Tue, 13 May 2014 10:28:42 +0200 Subject: commands: harmonize in-barebox documentation This patch does probably too much, but it's hard (and very cumbersome/time consuming) to break it out. What is does is this: * each command has one short description, e.g. "list MUX configuration" * made sure the short descriptions start lowercase * each command has one usage. That string contains just the options, e.g. "[-npn]". It's not part of the long help text. * that is, it doesn't say "[OPTIONS]" anymore, every usable option is listed by character in this (short) option string (the long description is in the long help text, as before) * help texts have been reworked, to make them - sometimes smaller - sometimes describe the options better - more often present themselves in a nicer format * all long help texts are now created with BUSYBOX_CMD_HELP_ macros, no more 'static const __maybe_unused char cmd_foobar_help[]' * made sure the long help texts starts uppercase * because cmdtp->name and cmdtp->opts together provide the new usage, all "Usage: foobar" texts have been removed from the long help texts * BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this is nicer in the source code * BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself * made sure no line gets longer than 77 characters * delibertely renamed cmdtp->usage, so that we can get compile-time errors (e.g. in out-of-tree modules that use register_command() * the 'help' command can now always emit the usage, even without compiled long help texts * 'help -v' gives a list of commands with their short description, this is similar like the old "help" command before my patchset * 'help -a' gives out help of all commands Signed-off-by: Holger Schurig Signed-off-by: Sascha Hauer --- arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c | 9 ++------- arch/arm/boards/guf-cupid/board.c | 9 ++------- arch/arm/boards/phytec-phycore-imx35/pcm043.c | 9 ++------- arch/arm/cpu/cpuinfo.c | 2 +- arch/arm/cpu/mmuinfo.c | 9 ++------- arch/arm/lib/bootu.c | 3 ++- arch/arm/lib/bootz.c | 8 ++------ arch/arm/mach-at91/boot_test_cmd.c | 8 +++++--- arch/arm/mach-at91/clock.c | 8 +------- arch/arm/mach-at91/gpio.c | 11 ++++++++--- arch/arm/mach-mxs/bcb.c | 8 ++++---- arch/arm/mach-netx/generic.c | 3 +-- arch/arm/mach-omap/boot_order.c | 12 ++++++------ arch/blackfin/boards/ipe337/cmd_alternate.c | 9 ++------- arch/mips/lib/cpuinfo.c | 2 +- arch/openrisc/lib/cpuinfo.c | 2 +- 16 files changed, 42 insertions(+), 70 deletions(-) (limited to 'arch') diff --git a/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c b/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c index f7b7a23363..378f4e80e6 100644 --- a/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c +++ b/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c @@ -352,14 +352,9 @@ static int do_cpufreq(int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_cpufreq_help[] = -"Usage: cpufreq 399|532\n" -"\n" -"Set CPU frequency to MHz\n"; - BAREBOX_CMD_START(cpufreq) .cmd = do_cpufreq, - .usage = "adjust CPU frequency", + BAREBOX_CMD_DESC("adjust CPU frequency") + BAREBOX_CMD_OPTS("399|532") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_cpufreq_help) BAREBOX_CMD_END diff --git a/arch/arm/boards/guf-cupid/board.c b/arch/arm/boards/guf-cupid/board.c index 793d845346..90f16272fd 100644 --- a/arch/arm/boards/guf-cupid/board.c +++ b/arch/arm/boards/guf-cupid/board.c @@ -346,14 +346,9 @@ static int do_cpufreq(int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_cpufreq_help[] = -"Usage: cpufreq 399|532\n" -"\n" -"Set CPU frequency to MHz\n"; - BAREBOX_CMD_START(cpufreq) .cmd = do_cpufreq, - .usage = "adjust CPU frequency", + BAREBOX_CMD_DESC("adjust CPU frequency") + BAREBOX_CMD_OPTS("399|532") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_cpufreq_help) BAREBOX_CMD_END diff --git a/arch/arm/boards/phytec-phycore-imx35/pcm043.c b/arch/arm/boards/phytec-phycore-imx35/pcm043.c index f6e370f36d..d1dd28fc65 100644 --- a/arch/arm/boards/phytec-phycore-imx35/pcm043.c +++ b/arch/arm/boards/phytec-phycore-imx35/pcm043.c @@ -324,15 +324,10 @@ static int do_cpufreq(int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_cpufreq_help[] = -"Usage: cpufreq 399|532\n" -"\n" -"Set CPU frequency to MHz\n"; - BAREBOX_CMD_START(cpufreq) .cmd = do_cpufreq, - .usage = "adjust CPU frequency", + BAREBOX_CMD_DESC("adjust CPU frequency") + BAREBOX_CMD_OPTS("399|532") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_cpufreq_help) BAREBOX_CMD_END diff --git a/arch/arm/cpu/cpuinfo.c b/arch/arm/cpu/cpuinfo.c index 2cee48b43d..8b22e9bb50 100644 --- a/arch/arm/cpu/cpuinfo.c +++ b/arch/arm/cpu/cpuinfo.c @@ -210,7 +210,7 @@ static int do_cpuinfo(int argc, char *argv[]) BAREBOX_CMD_START(cpuinfo) .cmd = do_cpuinfo, - .usage = "Show info about CPU", + BAREBOX_CMD_DESC("show info about CPU") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_COMPLETE(empty_complete) BAREBOX_CMD_END diff --git a/arch/arm/cpu/mmuinfo.c b/arch/arm/cpu/mmuinfo.c index 032798e9f5..79f539f888 100644 --- a/arch/arm/cpu/mmuinfo.c +++ b/arch/arm/cpu/mmuinfo.c @@ -99,14 +99,9 @@ static int do_mmuinfo(int argc, char *argv[]) return 0; } -BAREBOX_CMD_HELP_START(mmuinfo) -BAREBOX_CMD_HELP_USAGE("mmuinfo
\n") -BAREBOX_CMD_HELP_SHORT("Show MMU/cache information for an address.\n") -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(mmuinfo) .cmd = do_mmuinfo, - .usage = "mmuinfo
", + BAREBOX_CMD_DESC("show MMU/cache information of an address") + BAREBOX_CMD_OPTS("ADDRESS") BAREBOX_CMD_GROUP(CMD_GRP_INFO) - BAREBOX_CMD_HELP(cmd_mmuinfo_help) BAREBOX_CMD_END diff --git a/arch/arm/lib/bootu.c b/arch/arm/lib/bootu.c index 14a856678c..19009c88be 100644 --- a/arch/arm/lib/bootu.c +++ b/arch/arm/lib/bootu.c @@ -36,7 +36,8 @@ static const __maybe_unused char cmd_bootu_help[] = BAREBOX_CMD_START(bootu) .cmd = do_bootu, - .usage = "start a raw linux image", + BAREBOX_CMD_DESC("boot into already loaded Linux kernel") + BAREBOX_CMD_OPTS("ADDRESS") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_bootu_help) BAREBOX_CMD_END diff --git a/arch/arm/lib/bootz.c b/arch/arm/lib/bootz.c index 7ddd882f14..377f18a3ac 100644 --- a/arch/arm/lib/bootz.c +++ b/arch/arm/lib/bootz.c @@ -127,14 +127,10 @@ err_out: return 1; } -static const __maybe_unused char cmd_bootz_help[] = -"Usage: bootz [FILE]\n" -"Boot a Linux zImage\n"; - BAREBOX_CMD_START(bootz) .cmd = do_bootz, - .usage = "start a zImage", + BAREBOX_CMD_DESC("boot Linux zImage") + BAREBOX_CMD_OPTS("FILE") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) - BAREBOX_CMD_HELP(cmd_bootz_help) BAREBOX_CMD_END diff --git a/arch/arm/mach-at91/boot_test_cmd.c b/arch/arm/mach-at91/boot_test_cmd.c index 5f806665ae..66c598b7ce 100644 --- a/arch/arm/mach-at91/boot_test_cmd.c +++ b/arch/arm/mach-at91/boot_test_cmd.c @@ -84,13 +84,15 @@ err: } BAREBOX_CMD_HELP_START(at91_boot_test) -BAREBOX_CMD_HELP_USAGE("at91_boot_test [-j ] [-s ] file\n") -BAREBOX_CMD_HELP_SHORT("upload the binary to sram and jump as will do the romcode\n") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-j ADDR", "jump address") +BAREBOX_CMD_HELP_OPT ("-s SRAM", "SRAM device (default /dev/sram0)") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(at91_boot_test) .cmd = do_at91_boot_test, - .usage = "upload the binary to sram and jump as will do the romcode", + BAREBOX_CMD_DESC("load and execute from SRAM") + BAREBOX_CMD_OPTS("at91_boot_test [-js] FILE") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_at91_boot_test_help) BAREBOX_CMD_END diff --git a/arch/arm/mach-at91/clock.c b/arch/arm/mach-at91/clock.c index c4fc698bc1..59c4d1111f 100644 --- a/arch/arm/mach-at91/clock.c +++ b/arch/arm/mach-at91/clock.c @@ -881,16 +881,10 @@ static int do_at91clk(int argc, char *argv[]) return 0; } -BAREBOX_CMD_HELP_START(at91clk) -BAREBOX_CMD_HELP_USAGE("at91clk\n") -BAREBOX_CMD_HELP_SHORT("dump current clock configuration\n"); -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(at91clk) .cmd = do_at91clk, - .usage = "dump current clock configuration", + BAREBOX_CMD_DESC("list clock configuration") BAREBOX_CMD_GROUP(CMD_GRP_INFO) - BAREBOX_CMD_HELP(cmd_at91clk_help) BAREBOX_CMD_COMPLETE(empty_complete) BAREBOX_CMD_END #endif diff --git a/arch/arm/mach-at91/gpio.c b/arch/arm/mach-at91/gpio.c index c175cfd2cb..292e1975e9 100644 --- a/arch/arm/mach-at91/gpio.c +++ b/arch/arm/mach-at91/gpio.c @@ -509,13 +509,18 @@ static int do_at91mux(int argc, char *argv[]) } BAREBOX_CMD_HELP_START(at91mux) -BAREBOX_CMD_HELP_USAGE("at91mux [-p -b ]\n") -BAREBOX_CMD_HELP_SHORT("dump current mux configuration if bank/pin specified dump pin details\n"); +BAREBOX_CMD_HELP_TEXT("Dump current MIX configuration. If a BANK or PIN has been") +BAREBOX_CMD_HELP_TEXT("specified dump pin details.") +BAREBOX_CMD_HELP_TEXT("") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-p PIN", "pin number") +BAREBOX_CMD_HELP_OPT ("-b BANK", "bank number") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(at91mux) .cmd = do_at91mux, - .usage = "dump current mux configuration", + BAREBOX_CMD_DESC("list MUX configuration") + BAREBOX_CMD_OPTS("[-pn]") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_HELP(cmd_at91mux_help) BAREBOX_CMD_COMPLETE(empty_complete) diff --git a/arch/arm/mach-mxs/bcb.c b/arch/arm/mach-mxs/bcb.c index 0da8d3b928..c945726f53 100644 --- a/arch/arm/mach-mxs/bcb.c +++ b/arch/arm/mach-mxs/bcb.c @@ -387,14 +387,14 @@ int update_bcb(int argc, char *argv[]) } BAREBOX_CMD_HELP_START(bcb) -BAREBOX_CMD_HELP_USAGE("bcb [second_bootstream]\n") -BAREBOX_CMD_HELP_SHORT("Write a BCB to NAND flash which an MX23/28 needs to boot.\n") -BAREBOX_CMD_HELP_TEXT ("Example: bcb nand0.bootstream\n") +BAREBOX_CMD_HELP_TEXT("Write a BCB to NAND flash which an MX23/28 needs to boot.") +BAREBOX_CMD_HELP_TEXT("Example: bcb nand0.bootstream") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(bcb) .cmd = update_bcb, - .usage = "Writes a MX23/28 BCB data structure to flash", + BAREBOX_CMD_DESC("writes a i.MX23/28 BCB data structure to flash") + BAREBOX_CMD_OPTS("BOOTSTREAM [BOOTSTREAM]") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_bcb_help) BAREBOX_CMD_END diff --git a/arch/arm/mach-netx/generic.c b/arch/arm/mach-netx/generic.c index 0b6b3b28dc..6127dde868 100644 --- a/arch/arm/mach-netx/generic.c +++ b/arch/arm/mach-netx/generic.c @@ -145,7 +145,6 @@ void __noreturn reset_cpu(unsigned long addr) BAREBOX_CMD_START(loadxc) .cmd = do_loadxc, - .usage = "load xmac/xpec engine with ethernet firmware", + BAREBOX_CMD_DESC("load XMAC/XPEC engine with ethernet firmware") BAREBOX_CMD_GROUP(CMD_GRP_NET) BAREBOX_CMD_END - diff --git a/arch/arm/mach-omap/boot_order.c b/arch/arm/mach-omap/boot_order.c index 4af86e6a49..db22513bde 100644 --- a/arch/arm/mach-omap/boot_order.c +++ b/arch/arm/mach-omap/boot_order.c @@ -69,15 +69,15 @@ static int cmd_boot_order(int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_boot_order_help[] = -"Usage: boot_order []\n" -"Set warm boot order of up to four devices.\n" -"Each device can be one of:\n" -"xip xipwait nand onenand mmc1 mmc2_1 mmc2_2 uart usb_1 usb_ulpi usb_2\n"; +BAREBOX_CMD_HELP_START(boot_order) +BAREBOX_CMD_HELP_TEXT("Set warm boot order of up to four devices. Each device can be one of:") +BAREBOX_CMD_HELP_TEXT("xip xipwait nand onenand mmc1 mmc2_1 mmc2_2 uart usb_1 usb_ulpi usb_2") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(boot_order) .cmd = cmd_boot_order, - .usage = "boot_order []", + BAREBOX_CMD_DESC("set warm boot order") + BAREBOX_CMD_OPTS("DEVICE...") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_boot_order_help) BAREBOX_CMD_COMPLETE(empty_complete) diff --git a/arch/blackfin/boards/ipe337/cmd_alternate.c b/arch/blackfin/boards/ipe337/cmd_alternate.c index aee9560bc0..992d274847 100644 --- a/arch/blackfin/boards/ipe337/cmd_alternate.c +++ b/arch/blackfin/boards/ipe337/cmd_alternate.c @@ -44,14 +44,9 @@ static int do_alternate(int argc, char *argv[]) return (bitcount & 1) ? 3 : 2; } -static const __maybe_unused char cmd_alternate_help[] = -"Usage: alternate " -"\n"; - BAREBOX_CMD_START(alternate) .cmd = do_alternate, - .usage = "count zero bits in a file", + BAREBOX_CMD_DESC("count zero bits in a file") + BAREBOX_CMD_OPTS("FILE") BAREBOX_CMD_GROUP(CMD_GRP_FILE) - BAREBOX_CMD_HELP(cmd_alternate_help) BAREBOX_CMD_END - diff --git a/arch/mips/lib/cpuinfo.c b/arch/mips/lib/cpuinfo.c index b541f70710..1b171697ba 100644 --- a/arch/mips/lib/cpuinfo.c +++ b/arch/mips/lib/cpuinfo.c @@ -54,6 +54,6 @@ static int do_cpuinfo(int argc, char *argv[]) BAREBOX_CMD_START(cpuinfo) .cmd = do_cpuinfo, - .usage = "Show info about CPU", + BAREBOX_CMD_DESC("show CPU information") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_END diff --git a/arch/openrisc/lib/cpuinfo.c b/arch/openrisc/lib/cpuinfo.c index 2a055aae0e..32fb47dd4c 100644 --- a/arch/openrisc/lib/cpuinfo.c +++ b/arch/openrisc/lib/cpuinfo.c @@ -148,6 +148,6 @@ static int do_cpuinfo(int argc, char *argv[]) BAREBOX_CMD_START(cpuinfo) .cmd = do_cpuinfo, - .usage = "Show info about CPU", + BAREBOX_CMD_DESC("show CPU information") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_END -- cgit v1.2.3