sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

doc: unify documentation for 'protect' and 'unprotect' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-11-01 17:41:42 +01:00 committed by Sascha Hauer
parent a3921e369f
commit 1114c84bc7
1 changed files with 42 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
commands/flash.c
View File

@ -162,43 +162,57 @@ out:
return ret;
}
static const __maybe_unused char cmd_protect_help[] =
"Usage: (un)protect <device> [area]\n"
"(un)protect a flash device or parts of a device if an area specification\n"
"is given\n";
BAREBOX_CMD_HELP_START(protect)
BAREBOX_CMD_HELP_USAGE("protect <device> [area]\n")
BAREBOX_CMD_HELP_SHORT("protect a flash device (or parts of a device, if an area is specified)\n")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(protect)
.cmd = do_protect,
.usage = "enable FLASH write protection",
.usage = "enable flash write protection",
BAREBOX_CMD_HELP(cmd_protect_help)
BAREBOX_CMD_END
/**
* @page protect_command
Protect the flash memory behind the device. It depends on the device
given, what area will be protected. If the device represents the whole
flash memory the whole memory will be protected. If the device
represents a partition on a main flash memory, only this partition part
will be protected.
Refer addpart_command, delpart_command and devinfo_command for partition
handling.
\todo Rework this documentation, what is an 'area'? Explain more about
flashes here.
*/
BAREBOX_CMD_HELP_START(unprotect)
BAREBOX_CMD_HELP_USAGE("unprotect <device> [area]\n")
BAREBOX_CMD_HELP_SHORT("unprotect a flash device (or parts of a device, if an area is specified)\n")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(unprotect)
.cmd = do_protect,
.usage = "disable FLASH write protection",
BAREBOX_CMD_HELP(cmd_protect_help)
.usage = "disable flash write protection",
BAREBOX_CMD_HELP(cmd_unprotect_help)
BAREBOX_CMD_END
/** @page protect_command protect Protect a flash memory
*
* Usage is: protect \<devicee>
*
* Protect the flash memory behind the device. It depends on the device given,
* what area will be protected. If the device represents the whole flash memory
* the whole memory will be protected. If the device represents a partition on
* a main flash memory, only this partition part will be protected.
*
* Refer \b addpart, \b delpart and \b devinfo for partition handling.
/**
* @page unprotect_command
Unprotect the flash memory behind the device. It depends on the device given,
what area will be unprotected. If the device represents the whole flash memory
the whole memory will be unprotected. If the device represents a partition
on a main flash memory, only this partition part will be unprotected.
Refer addpart_command, delpart_command and devinfo_command for partition
handling.
\todo Rework this documentation, what does it mean?
*/
/** @page unprotect_command unprotect Unprotect a flash memory
*
* Usage is: unprotect \<devicee>
*
* Unprotect the flash memory behind the device. It depends on the device given,
* what area will be unprotected. If the device represents the whole flash memory
* the whole memory will be unprotected. If the device represents a partition
* on a main flash memory, only this partition part will be unprotected.
*
* Refer \b addpart, \b delpart and \b devinfo for partition handling.
*/