summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-09 07:35:40 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:39 +0100
commit15e9789ce4deddc518d05df84b1f64f3c6739643 (patch)
tree062875bcba6d08f648e2a963bd5c416dfd41f8bd
parente40eafe60a904bc4f1a7e1b9ec3cbb47a4d5f00a (diff)
downloadbarebox-15e9789ce4deddc518d05df84b1f64f3c6739643.tar.gz
barebox-15e9789ce4deddc518d05df84b1f64f3c6739643.tar.xz
doc: add documentation for 'umount' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/umount.c14
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cc892d46..07ae9d2c 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
-@li @subpage umount
+@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 6ae58441..52956042 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,