[PATCH 16/34] doc: add documentation for 'insmod' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:30 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
commands/insmod.c | 13 +++++++++++--
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2775b2d..cf45b14 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
- at li @subpage insmod
+ at 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 d3b4d1a..65a7d36 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,
--
1.7.2.3
More information about the barebox
mailing list