[PATCH 04/34] doc: add documentation for 'umount' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:18 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
commands/umount.c | 14 +++++++++++---
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cc892d4..07ae9d2 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -102,7 +102,7 @@ available in @a Barebox:
@li @subpage ubiattach
@li @subpage ubimkvol
@li @subpage ubirmvol
- at li @subpage umount
+ at li @subpage umount_command
@li @subpage unlzo_command
@li @subpage unprotect_command
@li @subpage usb
diff --git a/commands/umount.c b/commands/umount.c
index 6ae5844..5295604 100644
--- a/commands/umount.c
+++ b/commands/umount.c
@@ -38,9 +38,17 @@ static int do_umount(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_umount_help[] =
-"Usage: umount <mountpoint>\n"
-"umount a filesystem mounted on a specific mountpoint\n";
+BAREBOX_CMD_HELP_START(umount)
+BAREBOX_CMD_HELP_USAGE("umount <mountpoint>\n")
+BAREBOX_CMD_HELP_SHORT("Unmount a filesystem mounted on a specific mountpoint.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page umount_command
+
+\todo Add an example
+
+ */
BAREBOX_CMD_START(umount)
.cmd = do_umount,
--
1.7.2.3
More information about the barebox
mailing list