mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Robert Schwebel <r.schwebel@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 25/34] doc: add documentation for 'source' command
Date: Wed, 15 Dec 2010 12:51:39 +0100	[thread overview]
Message-ID: <1292413908-464-26-git-send-email-r.schwebel@pengutronix.de> (raw)
In-Reply-To: <1292413908-464-1-git-send-email-r.schwebel@pengutronix.de>

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 common/hush.c              |   22 ++++++++++++----------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 430cc52..7f4e489 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -94,7 +94,7 @@ available in @a Barebox:
 @li @subpage setenv_command
 @li @subpage sh
 @li @subpage sleep_command
-@li @subpage source
+@li @subpage source_command
 @li @subpage test_command
 @li @subpage timeout_command
 @li @subpage true_command
diff --git a/common/hush.c b/common/hush.c
index 77610bb..4947173 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1691,21 +1691,23 @@ static int do_source(struct command *cmdtp, int argc, char *argv[])
 
 static const char *source_aliases[] = { ".", NULL};
 
-static const __maybe_unused char cmd_source_help[] =
-"Usage: .  filename [arguments]\n"
-"or     source filename [arguments]\n"
-"\n"
-"Read  and  execute  commands  from filename in the current shell\n"
-"environment and return the exit status of the last command  exe-\n"
-"cuted from filename\n";
+BAREBOX_CMD_HELP_START(source)
+BAREBOX_CMD_HELP_USAGE(". FILE [ARGS], source FILE [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Read and execute shell commands in the current shell.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page source_command
 
-static const __maybe_unused char cmd_source_usage[] =
-"execute shell script in current shell environment";
+The commands are executed in the current shell environment and return
+the exit status of the last command executed from FILE.
+
+ */
 
 BAREBOX_CMD_START(source)
 	.aliases	= source_aliases,
 	.cmd		= do_source,
-	.usage		= cmd_source_usage,
+	.usage		= "execute shell script in current shell environment"
 	BAREBOX_CMD_HELP(cmd_source_help)
 BAREBOX_CMD_END
 
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

  parent reply	other threads:[~2010-12-15 11:51 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-15 11:51 More Documentation Patches Robert Schwebel
2010-12-15 11:51 ` [PATCH 01/34] doc: remove non-existing references Robert Schwebel
2010-12-15 11:51 ` [PATCH 02/34] doc: add documentation for 'version' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 03/34] doc: add documentation for 'unlzo' command Robert Schwebel
2010-12-15 19:16   ` Sascha Hauer
2010-12-15 11:51 ` [PATCH 04/34] doc: add documentation for 'umount' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 05/34] doc: add documentation for 'usb' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 06/34] doc: add documentation for ubi commands Robert Schwebel
2010-12-15 11:51 ` [PATCH 07/34] doc: add documentation for 'timeout' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 08/34] doc: add documentation for 'true' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 09/34] doc: add documentation for 'sleep' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 10/34] doc: add documentation for 'rm' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 11/34] doc: add documentation for 'rmdir' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 12/34] doc: add documentation for 'mkdir' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 13/34] doc: add documentation for 'test' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 14/34] doc: add documentation for 'lsmod' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 15/34] doc: add documentation for 'readline' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 16/34] doc: add documentation for 'insmod' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 17/34] doc: add documentation for 'help' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 18/34] doc: add documentation for 'pwd' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 19/34] doc: add documentation for 'false' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 20/34] doc: add documentation for 'exec' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 21/34] doc: add documentation for 'reset' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 22/34] doc: add documentation for 'reginfo' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 23/34] doc: add documentation for 'meminfo' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 24/34] doc: add documentation for 'go' command Robert Schwebel
2010-12-15 11:51 ` Robert Schwebel [this message]
2010-12-15 11:51 ` [PATCH 26/34] doc: add documentation for 'sh' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 27/34] doc: add documentation for 'ping' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 28/34] doc: add documentation for 'nfs' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 29/34] doc: add documentation for 'rarpboot' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 30/34] doc: add documentation for 'passwd' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 31/34] doc: add documentation for 'nand' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 32/34] doc: add documentation for 'mw' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 33/34] doc: add documentation for 'memcmp' command Robert Schwebel
2010-12-15 11:51 ` [PATCH 34/34] doc: add documentation for 'md' command 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=1292413908-464-26-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