diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-13 22:07:47 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:42 +0100 |
| commit | e5719d611167de557d911cd584d3c04fe8cf63d4 (patch) | |
| tree | 6484ef97bcb449e2a43235037b77c7c5b5f899fc | |
| parent | 2599d47df49e00ff3c132c27cb80ecac5edaaec2 (diff) | |
| download | barebox-e5719d611167de557d911cd584d3c04fe8cf63d4.tar.gz barebox-e5719d611167de557d911cd584d3c04fe8cf63d4.tar.xz | |
doc: add documentation for 'nand' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | commands/nand.c | 22 |
2 files changed, 16 insertions, 8 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 44a72dab..881fc2cc 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -76,7 +76,7 @@ available in @a Barebox: @li @subpage mtest @li @subpage mw @li @subpage mycdev -@li @subpage nand +@li @subpage nand_command @li @subpage nand_boot_test @li @subpage nfs_command @li @subpage passwd_command diff --git a/commands/nand.c b/commands/nand.c index 0902f218..18c6bd33 100644 --- a/commands/nand.c +++ b/commands/nand.c @@ -354,15 +354,23 @@ static int do_nand(struct command *cmdtp, int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_nand_help[] = -"Usage: nand [OPTION]...\n" -"nand related commands\n" -" -a <dev> register a bad block aware device ontop of a normal nand device\n" -" -d <dev> deregister a bad block aware device\n" -" -b <ofs> <dev> mark block at offset ofs as bad\n"; +BAREBOX_CMD_HELP_START(nand) +BAREBOX_CMD_HELP_USAGE("nand [OPTIONS]\n") +BAREBOX_CMD_HELP_SHORT("NAND related commands.\n") +BAREBOX_CMD_HELP_OPT ("-a <dev>", "register a bad block aware device ontop of a normal nand device\n") +BAREBOX_CMD_HELP_OPT ("-d <dev>", "deregister a bad block aware device\n") +BAREBOX_CMD_HELP_OPT ("-b <ofs> <dev>", "mark block at offset ofs as bad\n") +BAREBOX_CMD_HELP_END + +/** + * @page nand_command + +\todo This does definitely need more documentation. + + */ BAREBOX_CMD_START(nand) .cmd = do_nand, - .usage = "NAND specific handling", + .usage = "NAND related commands", BAREBOX_CMD_HELP(cmd_nand_help) BAREBOX_CMD_END |