GitHub-Mirror/u-boot
2
0
Fork 0
mirror of https://github.com/Fishwaldo/u-boot.git synced 2025-06-21 14:11:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

General help message cleanup

Browse source 
Many of the help messages were not really helpful; for example, many
commands that take no arguments would not print a correct synopsis
line, but "No additional help available." which is not exactly wrong,
but not helpful either.

Commit ``Make "usage" messages more helpful.'' changed this
partially. But it also became clear that lots of "Usage" and "Help"
messages (fields "usage" and "help" in struct cmd_tbl_s respective)
were actually redundant.

This patch cleans this up - for example:

Before:
	=> help dtt
	dtt - Digital Thermometer and Thermostat

	Usage:
	dtt         - Read temperature from digital thermometer and thermostat.

After:
	=> help dtt
	dtt - Read temperature from Digital Thermometer and Thermostat

	Usage:
	dtt

Signed-off-by: Wolfgang Denk <wd@denx.de>
This commit is contained in:
Wolfgang Denk 2009-05-24 17:06:54 +02:00
parent 94796d8544
commit a89c33db96
165 changed files with 507 additions and 496 deletions
Download patch file Download diff file Expand all files Collapse all files

15
common/command.c
View file

@ -39,7 +39,7 @@ do_version (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
U_BOOT_CMD(
version, 1, 1, do_version,
"print monitor version",
NULL
""
);
#if defined(CONFIG_CMD_ECHO)
@ -73,7 +73,7 @@ U_BOOT_CMD(
echo, CONFIG_SYS_MAXARGS, 1, do_echo,
"echo args to console",
"[args..]\n"
" - echo args to console; \\c suppresses newline\n"
" - echo args to console; \\c suppresses newline"
);
#endif
@ -204,8 +204,7 @@ do_test (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
U_BOOT_CMD(
test, CONFIG_SYS_MAXARGS, 1, do_test,
"minimal test like /bin/sh",
"[args..]\n"
" - test functionality\n"
"[args..]"
);
int
@ -223,7 +222,7 @@ do_exit (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
U_BOOT_CMD(
exit, 2, 1, do_exit,
"exit script",
" - exit functionality\n"
""
);
@ -314,15 +313,15 @@ U_BOOT_CMD(
"'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"
"'help' with one or more command names as arguments."
);
/* This do not ust the U_BOOT_CMD macro as ? can't be used in symbol names */
/* This does not use the U_BOOT_CMD macro as ? can't be used in symbol names */
#ifdef CONFIG_SYS_LONGHELP
cmd_tbl_t __u_boot_cmd_question_mark Struct_Section = {
"?", CONFIG_SYS_MAXARGS, 1, do_help,
"alias for 'help'",
NULL
""
};
#else
cmd_tbl_t __u_boot_cmd_question_mark Struct_Section = {