summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-07-12 19:23:46 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2010-11-01 16:23:08 +0100
commitc33a7cac953445833cc96232000c1882217bf3bc (patch)
treefecbfbeb3bd8a022f1b6a082c351e678856cc2d5
parent95a4698dd1f6165500d41bf149ae4005998387cb (diff)
downloadbarebox-c33a7cac953445833cc96232000c1882217bf3bc.tar.gz
barebox-c33a7cac953445833cc96232000c1882217bf3bc.tar.xz
doc: unify documentation for 'cd'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--commands/cd.c17
1 files changed, 5 insertions, 12 deletions
diff --git a/commands/cd.c b/commands/cd.c
index a842f4dc20..d73be32ab9 100644
--- a/commands/cd.c
+++ b/commands/cd.c
@@ -47,21 +47,14 @@ static int do_cd(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_cd_help[] =
-"Usage: cd [directory]\n"
-"change to directory. If called without argument, change to /\n";
+BAREBOX_CMD_HELP_START(cd)
+BAREBOX_CMD_HELP_USAGE("cd [directory]\n")
+BAREBOX_CMD_HELP_SHORT("Change to directory.\n")
+BAREBOX_CMD_HELP_TEXT ("If called without an argument, change to the root directory /.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cd)
.cmd = do_cd,
.usage = "change working directory",
BAREBOX_CMD_HELP(cmd_cd_help)
BAREBOX_CMD_END
-
-/**
- * @page cd_command cd (change working directory)
- *
- * Usage is: cd [\<directory name>]
- *
- * Change to \<directory name>. If called without argument, change to \b /
- * (root)
- */