summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-10 22:06:37 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:40 +0100
commitd881f614b756a63b5b8ffb8f54a3de46702ed4e9 (patch)
tree6cf4cfb4ead45bc3e58a3687db63774793e592d6
parent0246d50afaa2d367edb36bab90a08cd353cae979 (diff)
downloadbarebox-d881f614b756a63b5b8ffb8f54a3de46702ed4e9.tar.gz
barebox-d881f614b756a63b5b8ffb8f54a3de46702ed4e9.tar.xz
doc: add documentation for 'insmod' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/insmod.c13
2 files changed, 12 insertions, 3 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2775b2d9..cf45b146 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -57,7 +57,7 @@ available in @a Barebox:
@li @subpage i2c_write
@li @subpage icache
@li @subpage iminfo
-@li @subpage insmod
+@li @subpage insmod_command
@li @subpage linux16_command
@li @subpage loadenv_command
@li @subpage loadb
diff --git a/commands/insmod.c b/commands/insmod.c
index d3b4d1ad..65a7d36b 100644
--- a/commands/insmod.c
+++ b/commands/insmod.c
@@ -32,8 +32,17 @@ static int do_insmod(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_insmod_help[] =
-"Usage: insmod <module>\n";
+BAREBOX_CMD_HELP_START(insmod)
+BAREBOX_CMD_HELP_USAGE("insmod MODULE\n")
+BAREBOX_CMD_HELP_SHORT("Insert a module.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page insmod_command
+
+\todo Add example for module handling.
+
+ */
BAREBOX_CMD_START(insmod)
.cmd = do_insmod,