barebox/commands/help.c
Carlo Caione 27b77dc415 cosmetic: improve command list display
Following from the Frank Jullien's patch, here is the same cosmetic correction
when the list of commands is printed (the problem was that the commands for
gpio_* were too long for the %10s alignment)

Signed-off-by: Carlo Caione <carlo.caione@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2012-10-12 10:52:53 +02:00

76 lines
2.1 KiB
C

/*
* (C) Copyright 2000-2003
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*
* See file CREDITS for list of people who contributed to this
* project.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*/
#include <common.h>
#include <command.h>
#include <complete.h>
/*
* Use puts() instead of printf() to avoid printf buffer overflow
* for long help messages
*/
static int do_help(int argc, char *argv[])
{
struct command *cmdtp;
int max_length = 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);
}
return 0;
}
/* command help (long version) */
if ((cmdtp = find_cmd(argv[1])) != NULL) {
barebox_cmd_usage(cmdtp);
return 0;
} else {
printf ("Unknown command '%s' - try 'help'"
" without arguments for list of all"
" known commands\n\n", argv[1]
);
return 1;
}
}
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"
"To get detailed help information for specific commands you can type\n"
"'help' with one or more command names as arguments.\n";
static const char *help_aliases[] = { "?", NULL};
BAREBOX_CMD_START(help)
.cmd = do_help,
.aliases = help_aliases,
.usage = "print online help",
BAREBOX_CMD_HELP(cmd_help_help)
BAREBOX_CMD_COMPLETE(command_complete)
BAREBOX_CMD_END