diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-13 21:34:55 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:41 +0100 |
| commit | 2599d47df49e00ff3c132c27cb80ecac5edaaec2 (patch) | |
| tree | d3a130b53b42aab353d9be6aa85b6cf94c97fa45 | |
| parent | 91ed5b8729ec9bdd218959319b61af01b640a670 (diff) | |
| download | barebox-2599d47df49e00ff3c132c27cb80ecac5edaaec2.tar.gz barebox-2599d47df49e00ff3c132c27cb80ecac5edaaec2.tar.xz | |
doc: add documentation for 'passwd' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | commands/passwd.c | 18 |
2 files changed, 14 insertions, 6 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 7a515c5c..44a72dab 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -79,7 +79,7 @@ available in @a Barebox: @li @subpage nand @li @subpage nand_boot_test @li @subpage nfs_command -@li @subpage passwd +@li @subpage passwd_command @li @subpage ping_command @li @subpage printenv_command @li @subpage protect_command diff --git a/commands/passwd.c b/commands/passwd.c index 94350911..092d7e96 100644 --- a/commands/passwd.c +++ b/commands/passwd.c @@ -85,11 +85,19 @@ disable: return ret; } -static const __maybe_unused char cmd_passwd_help[] = -"Usage: passwd\n" -"passwd allow you to specify a password\n" -"to disable it put an empty password\n" -; +BAREBOX_CMD_HELP_START(passwd) +BAREBOX_CMD_HELP_USAGE("passwd\n") +BAREBOX_CMD_HELP_SHORT("Allows you to specify a password.\n") +BAREBOX_CMD_HELP_END + +/** + * @page passwd_command + +To disable the password, specify an empty one. + +\todo Add an example. + + */ BAREBOX_CMD_START(passwd) .cmd = do_passwd, |