9
0
Fork 0

commands: group 'help' output

The old output of "help" was just producing a long list, that usually
scrolled of the screen (even on a X11 terminal). This list is more
compact, and also sorted by groups.

The old output format (plus grouping) is now available with 'help -v'.

Example:

   Information commands:
     ?, devinfo, help, iomem, meminfo, version
   Boot commands:
     boot, bootm, go, loadb, loads, loadx, loady, saves, uimage
   ...

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
Holger Schurig 2014-05-13 16:14:05 +02:00 committed by Sascha Hauer
parent 5a4d617a1c
commit ab23d0bb3f
124 changed files with 237 additions and 14 deletions

View File

@ -360,5 +360,6 @@ static const __maybe_unused char cmd_cpufreq_help[] =
BAREBOX_CMD_START(cpufreq)
.cmd = do_cpufreq,
.usage = "adjust CPU frequency",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_cpufreq_help)
BAREBOX_CMD_END

View File

@ -354,5 +354,6 @@ static const __maybe_unused char cmd_cpufreq_help[] =
BAREBOX_CMD_START(cpufreq)
.cmd = do_cpufreq,
.usage = "adjust CPU frequency",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_cpufreq_help)
BAREBOX_CMD_END

View File

@ -332,6 +332,7 @@ static const __maybe_unused char cmd_cpufreq_help[] =
BAREBOX_CMD_START(cpufreq)
.cmd = do_cpufreq,
.usage = "adjust CPU frequency",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_cpufreq_help)
BAREBOX_CMD_END

View File

@ -211,6 +211,7 @@ static int do_cpuinfo(int argc, char *argv[])
BAREBOX_CMD_START(cpuinfo)
.cmd = do_cpuinfo,
.usage = "Show info about CPU",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -107,5 +107,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(mmuinfo)
.cmd = do_mmuinfo,
.usage = "mmuinfo <address>",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_mmuinfo_help)
BAREBOX_CMD_END

View File

@ -37,6 +37,7 @@ static const __maybe_unused char cmd_bootu_help[] =
BAREBOX_CMD_START(bootu)
.cmd = do_bootu,
.usage = "start a raw linux image",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_bootu_help)
BAREBOX_CMD_END

View File

@ -134,6 +134,7 @@ static const __maybe_unused char cmd_bootz_help[] =
BAREBOX_CMD_START(bootz)
.cmd = do_bootz,
.usage = "start a zImage",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_bootz_help)
BAREBOX_CMD_END

View File

@ -91,5 +91,6 @@ 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_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_at91_boot_test_help)
BAREBOX_CMD_END

View File

@ -889,6 +889,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(at91clk)
.cmd = do_at91clk,
.usage = "dump current clock configuration",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_at91clk_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -516,6 +516,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(at91mux)
.cmd = do_at91mux,
.usage = "dump current mux configuration",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_at91mux_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -395,5 +395,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(bcb)
.cmd = update_bcb,
.usage = "Writes a MX23/28 BCB data structure to flash",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_bcb_help)
BAREBOX_CMD_END

View File

@ -146,5 +146,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_GROUP(CMD_GRP_NET)
BAREBOX_CMD_END

View File

@ -78,6 +78,7 @@ static const __maybe_unused char cmd_boot_order_help[] =
BAREBOX_CMD_START(boot_order)
.cmd = cmd_boot_order,
.usage = "boot_order <device 1> [<device n>]",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_boot_order_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -51,6 +51,7 @@ static const __maybe_unused char cmd_alternate_help[] =
BAREBOX_CMD_START(alternate)
.cmd = do_alternate,
.usage = "count zero bits in a file",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_alternate_help)
BAREBOX_CMD_END

View File

@ -55,4 +55,5 @@ static int do_cpuinfo(int argc, char *argv[])
BAREBOX_CMD_START(cpuinfo)
.cmd = do_cpuinfo,
.usage = "Show info about CPU",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_END

View File

@ -149,4 +149,5 @@ static int do_cpuinfo(int argc, char *argv[])
BAREBOX_CMD_START(cpuinfo)
.cmd = do_cpuinfo,
.usage = "Show info about CPU",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_END

View File

@ -385,5 +385,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(2048)
.cmd = do_2048,
.usage = "Usage: 2048",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_2048_help)
BAREBOX_CMD_END

View File

@ -67,6 +67,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(automount)
.cmd = do_automount,
.usage = "automount [OPTIONS] <PATH> <cmd>",
BAREBOX_CMD_GROUP(CMD_GRP_PART)
BAREBOX_CMD_HELP(cmd_automount_help)
BAREBOX_CMD_END

View File

@ -82,5 +82,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(barebox_update)
.cmd = do_barebox_update,
.usage = "update barebox",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_barebox_update_help)
BAREBOX_CMD_END

View File

@ -43,5 +43,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(basename)
.cmd = do_basename,
.usage = "strip directory and suffix from filenames",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_basename_help)
BAREBOX_CMD_END

View File

@ -480,6 +480,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(boot)
.cmd = do_boot,
.usage = "boot the machine",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_boot_help)
BAREBOX_CMD_END

View File

@ -162,6 +162,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(bootm)
.cmd = do_bootm,
.usage = "boot an application image",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_bootm_help)
BAREBOX_CMD_END

View File

@ -91,5 +91,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cat)
.cmd = do_cat,
.usage = "concatenate file(s)",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_cat_help)
BAREBOX_CMD_END

View File

@ -53,5 +53,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cd)
.cmd = do_cd,
.usage = "change working directory",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_cd_help)
BAREBOX_CMD_END

View File

@ -37,5 +37,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clear)
.cmd = do_clear,
.usage = "clear screen",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -26,6 +26,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clk_enable)
.cmd = do_clk_enable,
.usage = "enable a clock",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_clk_enable_help)
BAREBOX_CMD_END
@ -53,6 +54,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clk_disable)
.cmd = do_clk_disable,
.usage = "disable a clock",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_clk_disable_help)
BAREBOX_CMD_END
@ -81,6 +83,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clk_set_rate)
.cmd = do_clk_set_rate,
.usage = "set a clocks rate",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_clk_set_rate_help)
BAREBOX_CMD_END
@ -112,6 +115,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clk_dump)
.cmd = do_clk_dump,
.usage = "show information about registered clocks",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_clk_dump_help)
BAREBOX_CMD_END
@ -140,5 +144,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(clk_set_parent)
.cmd = do_clk_set_parent,
.usage = "set a parent of a clock",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_clk_set_parent_help)
BAREBOX_CMD_END

View File

@ -105,6 +105,7 @@ If you want to copy between memory blocks, use 'memcpy'.
BAREBOX_CMD_START(cp)
.cmd = do_cp,
.usage = "copy files",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_cp_help)
BAREBOX_CMD_END

View File

@ -121,5 +121,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(crc32)
.cmd = do_crc,
.usage = "crc32 checksum calculation",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_crc_help)
BAREBOX_CMD_END

View File

@ -89,6 +89,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(detect)
.cmd = do_detect,
.usage = "detect devices",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_COMPLETE(device_complete)
BAREBOX_CMD_HELP(cmd_detect_help)
BAREBOX_CMD_END

View File

@ -153,6 +153,7 @@ Example from an MPC5200 based system:
BAREBOX_CMD_START(devinfo)
.cmd = do_devinfo,
.usage = "Show information about devices and drivers.",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_devinfo_help)
BAREBOX_CMD_COMPLETE(device_complete)
BAREBOX_CMD_END

View File

@ -197,5 +197,6 @@ device1(name1)[sr],device2(name2)[sr]
BAREBOX_CMD_START(dfu)
.cmd = do_dfu,
.usage = "Device firmware update",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_dfu_help)
BAREBOX_CMD_END

View File

@ -90,6 +90,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(md5sum)
.cmd = do_md5,
.usage = "md5 checksum calculation",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_md5sum_help)
BAREBOX_CMD_END
@ -110,6 +111,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(sha1sum)
.cmd = do_sha1,
.usage = "sha1 checksum calculation",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_sha1sum_help)
BAREBOX_CMD_END
@ -130,6 +132,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(sha224sum)
.cmd = do_sha224,
.usage = "sha224 checksum calculation",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_sha224sum_help)
BAREBOX_CMD_END
@ -150,6 +153,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(sha256sum)
.cmd = do_sha256,
.usage = "sha256 checksum calculation",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_sha256sum_help)
BAREBOX_CMD_END

View File

@ -61,5 +61,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(dirname)
.cmd = do_dirname,
.usage = "strip last component from file name",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_dirname_help)
BAREBOX_CMD_END

View File

@ -122,6 +122,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(echo)
.cmd = do_echo,
.usage = "echo args to console",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_echo_help)
BAREBOX_CMD_END

View File

@ -565,6 +565,7 @@ BAREBOX_CMD_START(edit)
.cmd = do_edit,
.aliases = edit_aliases,
.usage = "Usage: (s)edit <file>",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_edit_help)
BAREBOX_CMD_END

View File

@ -53,4 +53,5 @@ out:
BAREBOX_CMD_START(exec)
.cmd = do_exec,
.usage = "execute a script",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_END

View File

@ -56,6 +56,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(export)
.cmd = do_export,
.usage = "export environment variables",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_export_help)
BAREBOX_CMD_END

View File

@ -29,6 +29,7 @@ static int do_false(int argc, char *argv[])
BAREBOX_CMD_START(false)
.cmd = do_false,
.usage = "do nothing, unsuccessfully",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -93,5 +93,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(filetype)
.cmd = do_filetype,
.usage = "detect file type",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_filetype_help)
BAREBOX_CMD_END

View File

@ -82,6 +82,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(erase)
.cmd = do_flerase,
.usage = "erase FLASH memory",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_erase_help)
BAREBOX_CMD_END
@ -156,6 +157,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(protect)
.cmd = do_protect,
.usage = "enable flash write protection",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_protect_help)
BAREBOX_CMD_END
@ -184,6 +186,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(unprotect)
.cmd = do_protect,
.usage = "disable flash write protection",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_unprotect_help)
BAREBOX_CMD_END

View File

@ -69,5 +69,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(global)
.cmd = do_global,
.usage = "create or set global variables",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_global_help)
BAREBOX_CMD_END

View File

@ -87,6 +87,7 @@ static const __maybe_unused char cmd_go_help[] =
BAREBOX_CMD_START(go)
.cmd = do_go,
.usage = "start application at address or file",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_go_help)
BAREBOX_CMD_COMPLETE(command_var_complete)
BAREBOX_CMD_END

View File

@ -40,6 +40,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(gpio_get_value)
.cmd = do_gpio_get_value,
.usage = "return value of a gpio pin",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_gpio_get_value_help)
BAREBOX_CMD_END
@ -66,6 +67,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(gpio_set_value)
.cmd = do_gpio_set_value,
.usage = "set a gpio's output value",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_gpio_set_value_help)
BAREBOX_CMD_END
@ -93,6 +95,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(gpio_direction_input)
.cmd = do_gpio_direction_input,
.usage = "set direction of a gpio pin to input",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_gpio_direction_input_help)
BAREBOX_CMD_END
@ -121,6 +124,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(gpio_direction_output)
.cmd = do_gpio_direction_output,
.usage = "set direction of a gpio pin to output",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_gpio_direction_output_help)
BAREBOX_CMD_END

View File

@ -19,8 +19,68 @@
#include <common.h>
#include <command.h>
#include <getopt.h>
#include <complete.h>
static void list_group(int verbose, const char *grpname, uint32_t group)
{
struct command *cmdtp;
bool first = true;
int pos = 0;
int len;
for_each_command(cmdtp) {
if (cmdtp->group != group)
continue;
if (first) {
first = false;
printf("%s commands:\n", grpname);
if (!verbose) {
printf(" ");
pos = 2;
}
}
if (verbose) {
printf(" %-21s %s\n", cmdtp->name, cmdtp->usage);
continue;
}
len = strlen(cmdtp->name);
if (pos + len + 2 > 77) {
printf("\n %s", cmdtp->name);
pos = len + 2;
} else {
if (pos != 2) {
printf(", ");
pos += 2;
}
printf(cmdtp->name);
pos += len;
}
}
if (!first)
printf("\n");
}
static void list_commands(int verbose)
{
putchar('\n');
list_group(verbose, "Information", CMD_GRP_INFO);
list_group(verbose, "Boot", CMD_GRP_BOOT);
list_group(verbose, "Environment", CMD_GRP_ENV);
list_group(verbose, "Partition", CMD_GRP_PART);
list_group(verbose, "File", CMD_GRP_FILE);
list_group(verbose, "Scripting", CMD_GRP_SCRIPT);
list_group(verbose, "Network", CMD_GRP_NET);
list_group(verbose, "Console", CMD_GRP_CONSOLE);
list_group(verbose, "Memory", CMD_GRP_MEM);
list_group(verbose, "Hardware manipulation", CMD_GRP_HWMANIP);
list_group(verbose, "Miscellaneous", CMD_GRP_MISC);
list_group(verbose, "Ungrouped", 0);
printf("Use 'help COMMAND' for more details.\n\n");
}
/*
* Use puts() instead of printf() to avoid printf buffer overflow
* for long help messages
@ -28,23 +88,23 @@
static int do_help(int argc, char *argv[])
{
struct command *cmdtp;
int max_length = 0;
int opt, verbose = 0;
if (argc == 1) { /* show list of commands */
for_each_command(cmdtp)
if(strlen(cmdtp->name) > max_length)
max_length = strlen(cmdtp->name);
for_each_command(cmdtp) {
if (!cmdtp->usage)
continue;
printf("%*s - %s\n", max_length, cmdtp->name, cmdtp->usage);
while ((opt = getopt(argc, argv, "v")) > 0) {
switch (opt) {
case 'v':
verbose = 1;
break;
}
}
if (optind == argc) { /* show list of commands */
list_commands(verbose);
return 0;
}
/* command help (long version) */
if ((cmdtp = find_cmd(argv[1])) != NULL) {
if ((cmdtp = find_cmd(argv[optind])) != NULL) {
barebox_cmd_usage(cmdtp);
return 0;
} else {
@ -59,9 +119,9 @@ static int do_help(int argc, char *argv[])
static const __maybe_unused char cmd_help_help[] =
"Show help information (for 'command')\n"
"'help' prints online help for the monitor commands.\n\n"
"Without arguments, it prints a short usage message for all commands.\n\n"
"Without arguments, it lists all all commands.\n\n"
"To get detailed help information for specific commands you can type\n"
"'help' with one or more command names as arguments.\n";
"'help' with a command names as argument.\n";
static const char *help_aliases[] = { "?", NULL};
@ -69,6 +129,7 @@ BAREBOX_CMD_START(help)
.cmd = do_help,
.aliases = help_aliases,
.usage = "print online help",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_HELP(cmd_help_help)
BAREBOX_CMD_COMPLETE(command_complete)
BAREBOX_CMD_END

View File

@ -63,6 +63,7 @@ static const __maybe_unused char cmd_i2c_probe_help[] =
BAREBOX_CMD_START(i2c_probe)
.cmd = do_i2c_probe,
.usage = "probe for an i2c device",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_i2c_probe_help)
BAREBOX_CMD_END
@ -140,6 +141,7 @@ static const __maybe_unused char cmd_i2c_write_help[] =
BAREBOX_CMD_START(i2c_write)
.cmd = do_i2c_write,
.usage = "write to an i2c device",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_i2c_write_help)
BAREBOX_CMD_END
@ -214,5 +216,6 @@ static const __maybe_unused char cmd_i2c_read_help[] =
BAREBOX_CMD_START(i2c_read)
.cmd = do_i2c_read,
.usage = "read from an i2c device",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_i2c_read_help)
BAREBOX_CMD_END

View File

@ -33,10 +33,11 @@ static int do_insmod(int argc, char *argv[])
}
static const __maybe_unused char cmd_insmod_help[] =
"Usage: insmod <module>\n";
"Usage: insmod <module>\n";
BAREBOX_CMD_START(insmod)
.cmd = do_insmod,
.usage = "insert a module",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_insmod_help)
BAREBOX_CMD_END

View File

@ -50,6 +50,7 @@ static int do_iomem(int argc, char *argv[])
BAREBOX_CMD_START(iomem)
.cmd = do_iomem,
.usage = "show iomem usage",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_END
#if IO_SPACE_LIMIT > 0
@ -63,5 +64,6 @@ static int do_ioport(int argc, char *argv[])
BAREBOX_CMD_START(ioport)
.cmd = do_ioport,
.usage = "show ioport usage",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_END
#endif

View File

@ -88,5 +88,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(led)
.cmd = do_led,
.usage = "led <led> <value>",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_led_help)
BAREBOX_CMD_END

View File

@ -89,5 +89,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(let)
.cmd = do_let,
.usage = "evaluate arithmetic expressions",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_let_help)
BAREBOX_CMD_END

View File

@ -338,6 +338,7 @@ x86_boot_preparation for more info about how to use this command.</p>
BAREBOX_CMD_START(linux16)
.cmd = do_linux16,
.usage = "boot a linux kernel",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_linux16_help)
BAREBOX_CMD_END

View File

@ -53,5 +53,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(linux_exec)
.cmd = do_linux_exec,
.usage = "Execute a command on the host",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_linux_exec_help)
BAREBOX_CMD_END

View File

@ -47,5 +47,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(ln)
.cmd = do_ln,
.usage = "symlink - make a new name for a file",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_ln_help)
BAREBOX_CMD_END

View File

@ -708,5 +708,6 @@ static const __maybe_unused char cmd_loadb_help[] =
BAREBOX_CMD_START(loadb)
.cmd = do_load_serial_bin,
.usage = "Load binary file over serial line (kermit mode)",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_loadb_help)
BAREBOX_CMD_END

View File

@ -122,5 +122,6 @@ ENVFS can only handle files, directories are skipped silently.
BAREBOX_CMD_START(loadenv)
.cmd = do_loadenv,
.usage = "Load environment from ENVFS into DIRECTORY (default: /dev/env0 -> /env).",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_loadenv_help)
BAREBOX_CMD_END

View File

@ -277,6 +277,7 @@ static const __maybe_unused char cmd_loads_help[] =
BAREBOX_CMD_START(loads)
.cmd = do_load_serial,
.usage = "load S-Record file over serial line",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_loads_help)
BAREBOX_CMD_END
@ -293,6 +294,7 @@ static const __maybe_unused char cmd_saves_help[] =
BAREBOX_CMD_START(saves)
.cmd = do_save_serial,
.usage = "save S-Record file over serial line",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_saves_help)
BAREBOX_CMD_END
#endif /* CONFIG_CMD_SAVES */

View File

@ -236,6 +236,7 @@ static const __maybe_unused char cmd_loadx_help[] =
BAREBOX_CMD_START(loadx)
.cmd = do_loadx,
.usage = "Load binary file over serial line (X-Modem)",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_loadx_help)
BAREBOX_CMD_END
@ -248,6 +249,7 @@ static const __maybe_unused char cmd_loady_help[] =
BAREBOX_CMD_START(loady)
.cmd = do_loady,
.usage = "Load binary file over serial line (Y-Modem or Y-Modem/G)",
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_loady_help)
BAREBOX_CMD_END
#endif

View File

@ -87,6 +87,7 @@ static const __maybe_unused char cmd_login_help[] =
BAREBOX_CMD_START(login)
.cmd = do_login,
.usage = "login",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_login_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -212,5 +212,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(ls)
.cmd = do_ls,
.usage = "list a file or directory",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_ls_help)
BAREBOX_CMD_END

View File

@ -16,5 +16,6 @@ static int do_lsmod(int argc, char *argv[])
BAREBOX_CMD_START(lsmod)
.cmd = do_lsmod,
.usage = "list modules",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -17,4 +17,5 @@ static int do_magicvar(int argc, char *argv[])
BAREBOX_CMD_START(magicvar)
.cmd = do_magicvar,
.usage = "List information about magic variables",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_END

View File

@ -112,5 +112,6 @@ static const __maybe_unused char cmd_md_help[] =
BAREBOX_CMD_START(md)
.cmd = do_mem_md,
.usage = "memory display",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_md_help)
BAREBOX_CMD_END

View File

@ -144,5 +144,6 @@ static const __maybe_unused char cmd_memcmp_help[] =
BAREBOX_CMD_START(memcmp)
.cmd = do_memcmp,
.usage = "memory compare",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_memcmp_help)
BAREBOX_CMD_END

View File

@ -141,5 +141,6 @@ static const __maybe_unused char cmd_memcpy_help[] =
BAREBOX_CMD_START(memcpy)
.cmd = do_memcpy,
.usage = "memory copy",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_memcpy_help)
BAREBOX_CMD_END

View File

@ -31,5 +31,6 @@ static int do_meminfo(int argc, char *argv[])
BAREBOX_CMD_START(meminfo)
.cmd = do_meminfo,
.usage = "print info about memory usage",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -97,5 +97,6 @@ static const __maybe_unused char cmd_memset_help[] =
BAREBOX_CMD_START(memset)
.cmd = do_memset,
.usage = "memory fill",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_memset_help)
BAREBOX_CMD_END

View File

@ -239,5 +239,6 @@ static const __maybe_unused char cmd_memtest_help[] =
BAREBOX_CMD_START(memtest)
.cmd = do_memtest,
.usage = "Memory Test",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_memtest_help)
BAREBOX_CMD_END

View File

@ -472,5 +472,6 @@ static const __maybe_unused char cmd_menu_help[] =
BAREBOX_CMD_START(menu)
.cmd = do_menu,
.usage = "Menu Management",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_menu_help)
BAREBOX_CMD_END

View File

@ -56,5 +56,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(menutree)
.cmd = do_menutree,
.usage = "create a menu from a directory structure",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_menutree_help)
BAREBOX_CMD_END

View File

@ -298,5 +298,6 @@ adapters use an MII to autonegotiate link speed and duplex setting.
BAREBOX_CMD_START(miitool)
.cmd = do_miitool,
.usage = "view media-independent interface status",
BAREBOX_CMD_GROUP(CMD_GRP_NET)
BAREBOX_CMD_HELP(cmd_miitool_help)
BAREBOX_CMD_END

View File

@ -66,5 +66,6 @@ static const __maybe_unused char cmd_mkdir_help[] =
BAREBOX_CMD_START(mkdir)
.cmd = do_mkdir,
.usage = "make directories",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_mkdir_help)
BAREBOX_CMD_END

View File

@ -113,5 +113,6 @@ static const __maybe_unused char cmd_mm_help[] =
BAREBOX_CMD_START(mm)
.cmd = do_mem_mm,
.usage = "memory modify write with mask",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_mm_help)
BAREBOX_CMD_END

View File

@ -163,5 +163,6 @@ the filesystem has been unmounted.
BAREBOX_CMD_START(mount)
.cmd = do_mount,
.usage = "Mount a filesystem of a given type to a mountpoint or list mounted filesystems.",
BAREBOX_CMD_GROUP(CMD_GRP_PART)
BAREBOX_CMD_HELP(cmd_mount_help)
BAREBOX_CMD_END

View File

@ -37,4 +37,5 @@ static int do_msleep(int argc, char *argv[])
BAREBOX_CMD_START(msleep)
.cmd = do_msleep,
.usage = "delay execution for n milliseconds",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_END

View File

@ -100,5 +100,6 @@ static const __maybe_unused char cmd_mw_help[] =
BAREBOX_CMD_START(mw)
.cmd = do_mem_mw,
.usage = "memory write (fill)",
BAREBOX_CMD_GROUP(CMD_GRP_MEM)
BAREBOX_CMD_HELP(cmd_mw_help)
BAREBOX_CMD_END

View File

@ -110,5 +110,6 @@ static const __maybe_unused char cmd_nand_help[] =
BAREBOX_CMD_START(nand)
.cmd = do_nand,
.usage = "NAND specific handling",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_nand_help)
BAREBOX_CMD_END

View File

@ -349,5 +349,6 @@ static const __maybe_unused char cmd_nandtest_help[] =
BAREBOX_CMD_START(nandtest)
.cmd = do_nandtest,
.usage = "NAND Test",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_nandtest_help)
BAREBOX_CMD_END

View File

@ -63,6 +63,7 @@ static const __maybe_unused char cmd_ethact_help[] =
BAREBOX_CMD_START(ethact)
.cmd = do_ethact,
.usage = "set current ethernet device",
BAREBOX_CMD_GROUP(CMD_GRP_NET)
BAREBOX_CMD_HELP(cmd_ethact_help)
BAREBOX_CMD_COMPLETE(eth_complete)
BAREBOX_CMD_END

View File

@ -102,5 +102,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(of_node)
.cmd = do_of_node,
.usage = "handle of nodes",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_of_node_help)
BAREBOX_CMD_END

View File

@ -314,5 +314,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(of_property)
.cmd = do_of_property,
.usage = "handle of properties",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_of_property_help)
BAREBOX_CMD_END

View File

@ -204,5 +204,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(oftree)
.cmd = do_oftree,
.usage = "handle devicetrees",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_oftree_help)
BAREBOX_CMD_END

View File

@ -187,6 +187,7 @@ kernel or cmdline mtd partitions.
BAREBOX_CMD_START(addpart)
.cmd = do_addpart,
.usage = "adds a partition table to a device",
BAREBOX_CMD_GROUP(CMD_GRP_PART)
BAREBOX_CMD_HELP(cmd_addpart_help)
BAREBOX_CMD_END
@ -224,6 +225,7 @@ argument list is taken as a list of partitions to be deleted.
BAREBOX_CMD_START(delpart)
.cmd = do_delpart,
.usage = "delete partition(s)",
BAREBOX_CMD_GROUP(CMD_GRP_PART)
BAREBOX_CMD_HELP(cmd_delpart_help)
BAREBOX_CMD_COMPLETE(devfs_partition_complete)
BAREBOX_CMD_END

View File

@ -92,6 +92,7 @@ static const __maybe_unused char cmd_passwd_help[] =
BAREBOX_CMD_START(passwd)
.cmd = do_passwd,
.usage = "passwd",
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_HELP(cmd_passwd_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -34,4 +34,5 @@ static int cmd_poweroff(int argc, char *argv[])
BAREBOX_CMD_START(poweroff)
.cmd = cmd_poweroff,
.usage = "Perform POWER OFF of the board",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_END

View File

@ -73,5 +73,6 @@ printed.</p>
BAREBOX_CMD_START(printenv)
.cmd = do_printenv,
.usage = "Print value of one or all environment variables.",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_printenv_help)
BAREBOX_CMD_END

View File

@ -30,5 +30,6 @@ static int do_pwd(int argc, char *argv[])
BAREBOX_CMD_START(pwd)
.cmd = do_pwd,
.usage = "print working directory",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -59,5 +59,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(readf)
.cmd = do_readf,
.usage = "read file into variable",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_readf_help)
BAREBOX_CMD_END

View File

@ -48,6 +48,7 @@ static const __maybe_unused char cmd_readline_help[] =
BAREBOX_CMD_START(readline)
.cmd = do_readline,
.usage = "prompt for user input",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_readline_help)
BAREBOX_CMD_END

View File

@ -76,5 +76,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(readlink)
.cmd = do_readlink,
.usage = "read value of a symbolic link",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_readlink_help)
BAREBOX_CMD_END

View File

@ -30,5 +30,6 @@ static int do_reginfo(int argc, char *argv[])
BAREBOX_CMD_START(reginfo)
.cmd = do_reginfo,
.usage = "print register information",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -30,4 +30,5 @@ static int do_regulator(int argc, char *argv[])
BAREBOX_CMD_START(regulator)
.cmd = do_regulator,
.usage = "list regulators",
BAREBOX_CMD_GROUP(CMD_GRP_INFO)
BAREBOX_CMD_END

View File

@ -54,6 +54,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(reset)
.cmd = cmd_reset,
.usage = "Perform RESET of the CPU",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_reset_help)
BAREBOX_CMD_COMPLETE(empty_complete)
BAREBOX_CMD_END

View File

@ -66,5 +66,6 @@ static const __maybe_unused char cmd_rm_help[] =
BAREBOX_CMD_START(rm)
.cmd = do_rm,
.usage = "remove files",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_rm_help)
BAREBOX_CMD_END

View File

@ -28,5 +28,6 @@ static const __maybe_unused char cmd_rmdir_help[] =
BAREBOX_CMD_START(rmdir)
.cmd = do_rmdir,
.usage = "remove directorie(s)",
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_rmdir_help)
BAREBOX_CMD_END

View File

@ -55,6 +55,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(saveenv)
.cmd = do_saveenv,
.usage = "save environment to persistent storage",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_saveenv_help)
BAREBOX_CMD_END

View File

@ -53,5 +53,6 @@ in use. Within the hush shell, \c setenv is not required.</p>
BAREBOX_CMD_START(setenv)
.cmd = do_setenv,
.usage = "set environment variables",
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_setenv_help)
BAREBOX_CMD_END

View File

@ -44,5 +44,6 @@ static int do_sleep(int argc, char *argv[])
BAREBOX_CMD_START(sleep)
.cmd = do_sleep,
.usage = "delay execution for n seconds",
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_COMPLETE(command_var_complete)
BAREBOX_CMD_END

View File

@ -128,5 +128,6 @@ static const __maybe_unused char cmd_spi_help[] =
BAREBOX_CMD_START(spi)
.cmd = do_spi,
.usage = "write/read spi device",
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_spi_help)
BAREBOX_CMD_END

View File

@ -101,5 +101,6 @@ color depth.
BAREBOX_CMD_START(splash)
.cmd = do_splash,
.usage = "show a bmp image",
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_splash_help)
BAREBOX_CMD_END

View File

@ -237,5 +237,6 @@ BAREBOX_CMD_START(test)
.aliases = test_aliases,
.cmd = do_test,
.usage = cmd_test_usage,
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_test_help)
BAREBOX_CMD_END

View File

@ -99,5 +99,6 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(tftp)
.cmd = do_tftpb,
.usage = "(up-)Load file using tftp protocol",
BAREBOX_CMD_GROUP(CMD_GRP_NET)
BAREBOX_CMD_HELP(cmd_tftp_help)
BAREBOX_CMD_END

Some files were not shown because too many files have changed in this diff Show More