[PATCH 1/9] trivial: relocate doxygen help page for time command

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Mark Vels <mark.vels@xxxxxxxxxxxxxxxx>
---
 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@xxxxxxxxxxxxxxxxxxx
http://lists.infradead.org/mailman/listinfo/barebox


[Index of Archives]     [Linux Embedded]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [XFree86]

  Powered by Linux