From: Robert Schwebel <r.schwebel@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 10/21] doc: add documentation for 'echo'
Date: Mon, 1 Nov 2010 09:33:43 +0100 [thread overview]
Message-ID: <1288600434-6112-11-git-send-email-r.schwebel@pengutronix.de> (raw)
In-Reply-To: <1288600434-6112-1-git-send-email-r.schwebel@pengutronix.de>
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/echo.c | 17 +++++++++++++++++
2 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 4bcf548..38968b5 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 dfa14d6..3e098df 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
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2010-11-01 8:34 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-01 8:33 Unified Documentation Robert Schwebel
2010-11-01 8:33 ` [PATCH 01/21] doc: fix typo Robert Schwebel
2010-11-01 8:33 ` [PATCH 02/21] doc: add macros to unify command help with doxygen Robert Schwebel
2010-11-01 8:33 ` [PATCH 03/21] doc: add documentation for 'bmp' Robert Schwebel
2010-11-01 8:33 ` [PATCH 04/21] doc: add documentation for 'clear' Robert Schwebel
2010-11-01 8:33 ` [PATCH 05/21] doc: add documentation for 'crc32' Robert Schwebel
2010-11-01 8:33 ` [PATCH 06/21] doc: add documentation for 'dfu' Robert Schwebel
2010-11-01 8:51 ` Baruch Siach
2010-11-01 10:03 ` Robert Schwebel
2010-11-01 8:33 ` [PATCH 07/21] doc: unify documentation for 'ls' Robert Schwebel
2010-11-01 8:33 ` [PATCH 08/21] doc: unify documentation for 'cat' Robert Schwebel
2010-11-01 8:33 ` [PATCH 09/21] doc: unify documentation for 'cd' Robert Schwebel
2010-11-01 8:33 ` Robert Schwebel [this message]
2010-11-01 8:33 ` [PATCH 11/21] doc: unify documentation for 'edit' Robert Schwebel
2010-11-01 8:33 ` [PATCH 12/21] doc: add documentation for 'bootm' Robert Schwebel
2010-11-01 8:33 ` [PATCH 13/21] doc: unify documentation for 'addpart' Robert Schwebel
2010-11-01 8:33 ` [PATCH 14/21] doc: unify documentation for 'cp' Robert Schwebel
2010-11-01 8:33 ` [PATCH 15/21] doc: unify documentation for 'delpart' Robert Schwebel
2010-11-01 8:33 ` [PATCH 16/21] doc: rework user manual Robert Schwebel
2010-11-01 8:33 ` [PATCH 17/21] doc: unify documentation for 'devinfo' Robert Schwebel
2010-11-01 8:33 ` [PATCH 18/21] doc: unify documentation for 'erase' Robert Schwebel
2010-11-01 8:33 ` [PATCH 19/21] doc: rework and unify documentation for gpio commands Robert Schwebel
2010-11-01 8:33 ` [PATCH 20/21] doc: unify documentation for 'export' Robert Schwebel
2010-11-01 8:33 ` [PATCH 21/21] doc: unify documentation for 'tftp' Robert Schwebel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1288600434-6112-11-git-send-email-r.schwebel@pengutronix.de \
--to=r.schwebel@pengutronix.de \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox