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

doc: unify documentation for 'addpart' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-10-18 21:02:19 +02:00 committed by Sascha Hauer
parent 5a1286d696
commit 2a2d59f174
1 changed files with 17 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
commands/partition.c
View File

@ -149,19 +149,23 @@ static int do_addpart(struct command * cmdtp, int argc, char *argv[])
return 0;
}
static const __maybe_unused char cmd_addpart_help[] =
"Usage: addpart <device> <partition description>\n"
"\n"
"addpart adds a partition description to a device. The partition description\n"
"has the form\n"
"size1[@offset1](name1)[ro],size2[@offset2](name2)[ro],...\n"
"<device> is the device name under. Size and offset can be given in decimal\n"
"or - if prefixed with 0x in hex. Both can have an optional suffix K,M,G.\n"
"The size of the last partition can be specified as '-' for the remaining\n"
"space of the device.\n"
"This format is the same as used in the Linux kernel for cmdline mtd partitions.\n"
"\n"
"Note: That this command has to be reworked and will probably change it's API.";
BAREBOX_CMD_HELP_START(addpart)
BAREBOX_CMD_HELP_USAGE("addpart <device> <part_desc>\n")
BAREBOX_CMD_HELP_SHORT("Add a partition description to a device.\n")
BAREBOX_CMD_HELP_OPT ("<device>", "device being worked on\n")
BAREBOX_CMD_HELP_OPT ("<part_desc>", "size1[@offset1](name1)[ro],size2[@offset2](name2)[ro],...\n")
BAREBOX_CMD_HELP_END
/**
* @page addpart_command
Size and offset can be given in decimal hex (prefixed with 0x). Both
can have an optional suffix K, M or G. The size of the last partition
can be specified as '-' for the remaining space on the device. This
format is the same as used by the Linux kernel or cmdline mtd
partitions.
\todo This command has to be reworked and will probably change it's API.
*/
BAREBOX_CMD_START(addpart)
.cmd = do_addpart,
@ -169,26 +173,6 @@ BAREBOX_CMD_START(addpart)
BAREBOX_CMD_HELP(cmd_addpart_help)
BAREBOX_CMD_END
/** @page addpart_command addpart Add a partition to a device
*
* Usage is: addpart \<device> \<partition description>
*
* Adds a partition description to a device. The partition description has the
* form
*
* size1[\@offset1](name1)[ro],size2[\@offset2](name2)[ro],...
*
* \<device> is the device name under. Size and offset can be given in decimal
* or - if prefixed with 0x - in hex. Both can have an optional suffix K,M,G.
* The size of the last partition can be specified as '-' for the remaining
* space of the device.
*
* @note The format is the same as used in the Linux kernel for cmdline mtd
* partitions.
*
* @note This command has to be reworked and will probably change it's API.
*/
static int do_delpart(struct command * cmdtp, int argc, char *argv[])
{
int i, err;