[PATCH 15/21] doc: unify documentation for 'delpart'
r.schwebel at pengutronix.de
Mon Nov 1 04:33:48 EDT 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
commands/partition.c | 35 +++++++++++++++++++++--------------
1 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/commands/partition.c b/commands/partition.c
index dd37bc2..db9b9fb 100644
@@ -158,11 +158,12 @@ 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
+The size and the offset can be given in decimal (without any prefix) and
+in 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.
@@ -188,9 +189,21 @@ static int do_delpart(struct command * cmdtp, int argc, char *argv)
-static const __maybe_unused char cmd_delpart_help =
-"Usage: delpart FILE...\n"
-"Delete partitions previously added to a device with addpart.\n";
+BAREBOX_CMD_HELP_USAGE("delpart <part 1> [<part n>] \n")
+BAREBOX_CMD_HELP_SHORT("Delete partitions previously added to a device with addpart.\n")
+ * @page delpart_command
+Partitions are created by adding their description with the addpart
+command. If you want to get rid of a partition again, use delpart. The
+argument list is taken as a list of partitions to be deleted.
+\todo Add an example
.cmd = do_delpart,
@@ -198,9 +211,3 @@ BAREBOX_CMD_START(delpart)
-/** @page delpart_command delpart Delete a partition
- * Usage is: delpart \<partions>
- * Delete a partition previously added to a device with addpart.
More information about the barebox