[PATCH 30/34] doc: add documentation for 'passwd' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:44 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
commands/passwd.c | 18 +++++++++++++-----
2 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7a515c5..44a72da 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
- at li @subpage passwd
+ at 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 9435091..092d7e9 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,
--
1.7.2.3
More information about the barebox
mailing list