mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Mark Vels <mark.vels@team-embedded.nl>
To: barebox@lists.infradead.org
Subject: [PATCH 1/9] trivial: relocate doxygen help page for time command
Date: Tue,  1 Nov 2011 11:09:37 +0100	[thread overview]
Message-ID: <f35f17e5a6067a62ed66c24f7f276a0b2187c85f.1320141619.git.mark.vels@team-embedded.nl> (raw)
In-Reply-To: <cover.1320141619.git.mark.vels@team-embedded.nl>
In-Reply-To: <cover.1320141619.git.mark.vels@team-embedded.nl>


Signed-off-by: Mark Vels <mark.vels@team-embedded.nl>
---
 Documentation/commands.dox |    1 +
 commands/time.c            |   10 ++++++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 5ef7829..2b5bc44 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -96,6 +96,7 @@ available in @a Barebox:
 @li @subpage sleep
 @li @subpage source
 @li @subpage test
+@li @subpage time_command
 @li @subpage timeout
 @li @subpage true
 @li @subpage tftp_command
diff --git a/commands/time.c b/commands/time.c
index 9a76945..2fcaac0 100644
--- a/commands/time.c
+++ b/commands/time.c
@@ -46,10 +46,16 @@ static int do_time(struct command *cmdtp, int argc, char *argv[])
 
 BAREBOX_CMD_HELP_START(time)
 BAREBOX_CMD_HELP_USAGE("time <command>\n")
-BAREBOX_CMD_HELP_SHORT("note: This command depends on <command> being interruptible,\n")
-BAREBOX_CMD_HELP_SHORT("Otherwise the timer may overrun resulting in incorrect results\n")
+BAREBOX_CMD_HELP_SHORT("measure execution time of a command. Requires <command> to be interruptible!\n")
 BAREBOX_CMD_HELP_END
 
+/**
+ * @page time_command
+
+\note	@li This command depends on <command> being interruptible, otherwise the timer may overrun resulting in incorrect results.
+	@li This command is available only if enabled in menuconfig.
+ */
+
 BAREBOX_CMD_START(time)
 	.cmd		= do_time,
 	.usage		= "measure execution time of a command",
-- 
1.7.0.4


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

  reply	other threads:[~2011-11-01 10:09 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-01 10:09 [RFC PATCH 0/9] Catch-up/clean-up doxygen documentation Mark Vels
2011-11-01 10:09 ` Mark Vels [this message]
2011-11-01 10:09 ` [PATCH 2/9] trivial: relocate doxygen help page for led command Mark Vels
2011-11-01 10:09 ` [PATCH 3/9] trivial: reorganize crc32 command doxygen output Mark Vels
2011-11-01 10:09 ` [PATCH 4/9] trivial: fix doxygen error in dlink-dir-320.dox Mark Vels
2011-11-01 10:09 ` [PATCH 5/9] trivial: De-orphan NAND doxygen output and fix @param syntax Mark Vels
2011-11-01 10:09 ` [PATCH 6/9] docs: Enable BAREBOX_CMD_HELP_TEXT() in generated documentation Mark Vels
2011-11-01 10:09 ` [PATCH 7/9] doxygen: Enable LONGHELP output in generated output Mark Vels
2011-11-01 10:09 ` [PATCH 8/9] trivial: Small change in page link title Mark Vels
2011-11-01 10:09 ` [PATCH 9/9] help: update of shell commands doxygen/online help documentation Mark Vels
2011-11-03  7:26 ` [RFC PATCH 0/9] Catch-up/clean-up doxygen documentation Sascha Hauer
2011-11-03 12:48   ` Mark Vels
2011-11-04  9:06     ` Sascha Hauer

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=f35f17e5a6067a62ed66c24f7f276a0b2187c85f.1320141619.git.mark.vels@team-embedded.nl \
    --to=mark.vels@team-embedded.nl \
    --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