diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-07-12 19:31:21 +0200 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-01 16:23:08 +0100 |
| commit | caaab184710a7cee9db5f6ee3e6e7fe6eb20a48c (patch) | |
| tree | ed497fad4ceadc1b90e148a0c8cf9b0d66781be4 | |
| parent | c33a7cac953445833cc96232000c1882217bf3bc (diff) | |
| download | barebox-caaab184710a7cee9db5f6ee3e6e7fe6eb20a48c.tar.gz barebox-caaab184710a7cee9db5f6ee3e6e7fe6eb20a48c.tar.xz | |
doc: add documentation for 'echo'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 1 | ||||
| -rw-r--r-- | commands/echo.c | 17 |
2 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 4bcf548cb6..38968b55ad 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -11,6 +11,7 @@ @li @subpage delpart_command @li @subpage devinfo_command @li @subpage dfu_command +@li @subpage echo_command @li @subpage edit_command @li @subpage erase_command @li @subpage export_command diff --git a/commands/echo.c b/commands/echo.c index dfa14d67b9..3e098df1d0 100644 --- a/commands/echo.c +++ b/commands/echo.c @@ -111,8 +111,25 @@ no_optarg_out: return 1; } +BAREBOX_CMD_HELP_START(echo) +BAREBOX_CMD_HELP_USAGE("echo [OPTIONS] [STRING]\n") +BAREBOX_CMD_HELP_SHORT("Display a line of text.\n") +BAREBOX_CMD_HELP_OPT ("-n", "do not output the trailing newline\n") +BAREBOX_CMD_HELP_OPT ("-a", "FIXME\n") +BAREBOX_CMD_HELP_OPT ("-o", "FIXME\n") +BAREBOX_CMD_HELP_OPT ("-e", "FIXME\n") +BAREBOX_CMD_HELP_END + +/** + * @page echo_command + +\todo Add documentation for -a, -o and -e. + + */ + BAREBOX_CMD_START(echo) .cmd = do_echo, .usage = "echo args to console", + BAREBOX_CMD_HELP(cmd_echo_help) BAREBOX_CMD_END |