summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-09 07:44:26 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:39 +0100
commit1f3aa569b8d9b40d79d390ab3ccbace3a92c91d0 (patch)
tree699eed3d07c2c97facdb1399434c061d8c815197
parent15e9789ce4deddc518d05df84b1f64f3c6739643 (diff)
downloadbarebox-1f3aa569b8d9b40d79d390ab3ccbace3a92c91d0.tar.gz
barebox-1f3aa569b8d9b40d79d390ab3ccbace3a92c91d0.tar.xz
doc: add documentation for 'usb' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--drivers/usb/core/usb.c14
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 07ae9d2c..d5536d34 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -105,7 +105,7 @@ available in @a Barebox:
@li @subpage umount_command
@li @subpage unlzo_command
@li @subpage unprotect_command
-@li @subpage usb
+@li @subpage usb_command
@li @subpage version_command
*/
diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
index 76e033eb..38042a50 100644
--- a/drivers/usb/core/usb.c
+++ b/drivers/usb/core/usb.c
@@ -488,9 +488,17 @@ static int do_usb(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_usb_help[] =
-"Usage: usb\n"
-"(re-)detect USB devices\n";
+BAREBOX_CMD_HELP_START(usb)
+BAREBOX_CMD_HELP_USAGE("usb\n")
+BAREBOX_CMD_HELP_SHORT("(re-)detect USB devices.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page usb_command
+
+\todo add examples
+
+ */
BAREBOX_CMD_START(usb)
.cmd = do_usb,