sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

doc: unify documentation for 'setenv' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-11-01 18:04:04 +01:00 committed by Sascha Hauer
parent d462c9edbb
commit e1ea0bb4b2
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
commands/setenv.c
View File

@ -38,27 +38,23 @@ static int do_setenv(struct command *cmdtp, int argc, char *argv[])
return 0;
}
static const __maybe_unused char cmd_setenv_help[] =
"name value ...\n"
" - set environment variable 'name' to 'value ...'\n"
"setenv name\n"
" - delete environment variable 'name'\n";
BAREBOX_CMD_HELP_START(setenv)
BAREBOX_CMD_HELP_USAGE("setenv <name> [<value>]\n")
BAREBOX_CMD_HELP_SHORT("Set environment variable to a value or delete if value is avoided.\n")
BAREBOX_CMD_HELP_END
/**
* @page setenv_command
<p> This command is only available if the simple command line parser is
in use. Within the hush shell, \c setenv is not required.</p>
\todo Check if kconfig does this correctly.
*/
BAREBOX_CMD_START(setenv)
.cmd = do_setenv,
.usage = "set environment variables",
BAREBOX_CMD_HELP(cmd_setenv_help)
BAREBOX_CMD_END
/**
* @page setenv_command setenv: set an environment variable
*
* Usage: setenv \<name> [\<value>]
*
* Set environment variable \<name> to \<value>. Without a given value, the
* environment variable will be deleted.
*
* @note This command is only available if the simple command line parser is
* in use. Within the hush shell \c setenv is not required.
*/