[PATCH 12/34] doc: add documentation for 'mkdir' command

Robert Schwebel r.schwebel at pengutronix.de
Wed Dec 15 06:51:26 EST 2010


Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/mkdir.c           |   16 +++++++++++++---
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index db3be1a..45947e9 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -71,7 +71,7 @@ available in @a Barebox:
 @li @subpage meminfo
 @li @subpage memset
 @li @subpage menu
- at li @subpage mkdir
+ at li @subpage mkdir_command
 @li @subpage mount_command
 @li @subpage mtest
 @li @subpage mw
diff --git a/commands/mkdir.c b/commands/mkdir.c
index b66795b..9e37775 100644
--- a/commands/mkdir.c
+++ b/commands/mkdir.c
@@ -59,9 +59,19 @@ static int do_mkdir(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_mkdir_help[] =
-"Usage: mkdir [directories]\n"
-"Create new directories\n";
+BAREBOX_CMD_HELP_START(mkdir)
+BAREBOX_CMD_HELP_USAGE("mkdir DIRECTORIES\n")
+BAREBOX_CMD_HELP_SHORT("Create new directories.\n")
+BAREBOX_CMD_HELP_OPT  ("-p", "create all parent directories\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page mkdir_command
+
+When called with the '-p' option, mkdir creates all non-existing parent
+directories.
+
+ */
 
 BAREBOX_CMD_START(mkdir)
 	.cmd		= do_mkdir,
-- 
1.7.2.3




More information about the barebox mailing list