summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-10 21:26:23 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:40 +0100
commit1171fb6587bdbf4efcb99ebd3d90e56711c1d209 (patch)
tree233257f171539eb6da9ed6083418f4f68f927db3
parentb8c4b0b8b5293a4809349323ea67db4ce27547cc (diff)
downloadbarebox-1171fb6587bdbf4efcb99ebd3d90e56711c1d209.tar.gz
barebox-1171fb6587bdbf4efcb99ebd3d90e56711c1d209.tar.xz
doc: add documentation for 'rm' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/rm.c7
2 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 65980029..b0919d08 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -88,7 +88,7 @@ available in @a Barebox:
@li @subpage reset
@li @subpage rarpboot
@li @subpage reginfo
-@li @subpage rm
+@li @subpage rm_command
@li @subpage rmdir
@li @subpage saveenv_command
@li @subpage setenv_command
diff --git a/commands/rm.c b/commands/rm.c
index 3437ae57..4a45fee0 100644
--- a/commands/rm.c
+++ b/commands/rm.c
@@ -42,9 +42,10 @@ static int do_rm(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_rm_help[] =
-"Usage: rm [FILES]\n"
-"Remove files\n";
+BAREBOX_CMD_HELP_START(rm)
+BAREBOX_CMD_HELP_USAGE("rm FILE\n")
+BAREBOX_CMD_HELP_SHORT("Remove files.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(rm)
.cmd = do_rm,