diff options
author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-10-31 20:58:20 +0100 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-01 16:23:09 +0100 |
commit | 27aac2589cd2bd35b010f21e9593494d28c58a56 (patch) | |
tree | 249faa3259b8b5c81262ee1856f2a0baa0339b2b /commands/flash.c | |
parent | 681f821d05116c20dcb59cf76d87a5e1b04767bd (diff) | |
download | barebox-27aac2589cd2bd35b010f21e9593494d28c58a56.tar.gz barebox-27aac2589cd2bd35b010f21e9593494d28c58a56.tar.xz |
doc: unify documentation for 'erase'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'commands/flash.c')
-rw-r--r-- | commands/flash.c | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/commands/flash.c b/commands/flash.c index 20f5cfc33a..4549f0adac 100644 --- a/commands/flash.c +++ b/commands/flash.c @@ -83,10 +83,10 @@ out: return ret; } -static const __maybe_unused char cmd_erase_help[] = -"Usage: erase <device> [area]\n" -"Erase a flash device or parts of a device if an area specification\n" -"is given\n"; +BAREBOX_CMD_HELP_START(erase) +BAREBOX_CMD_HELP_USAGE("erase <device> [area]\n") +BAREBOX_CMD_HELP_SHORT("Erase a flash device or parts of a device if an area specification is given.\n") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(erase) .cmd = do_flerase, @@ -94,16 +94,18 @@ BAREBOX_CMD_START(erase) BAREBOX_CMD_HELP(cmd_erase_help) BAREBOX_CMD_END -/** @page erase_command erase Erase flash memory - * - * Usage is: erase \<devicee> - * - * Erase the flash memory behind the device. It depends on the device given, - * what area will be erased. If the device represents the whole flash memory - * the whole memory will be erased. If the device represents a partition on - * a main flash memory, only this partition part will be erased. - * - * Refer \b addpart, \b delpart and \b devinfo for partition handling. +/** + * @page erase_command + +<p> Erase the flash memory handled by this device. Which area will be +erased depends on the device: If the device represents the whole flash +memory, the whole memory will be erased. If the device represents a +partition on a main flash memory, only this partition part will be +erased. </p> + +Refer to \ref addpart_command, \ref delpart_command and \ref +devinfo_command for partition handling. + */ static int do_protect(struct command *cmdtp, int argc, char *argv[]) |