summaryrefslogtreecommitdiffstats
path: root/commands/partition.c
diff options
context:
space:
mode:
authorJuergen Beisert <j.beisert@pengutronix.de>2007-11-09 14:05:23 +0100
committerJuergen Beisert <j.beisert@pengutronix.de>2007-11-09 14:05:23 +0100
commit3ff14ef200fc6f69b6237fffabbad796aa463cfb (patch)
treee6e749f27cbd14641eac77e46e8e52736cb0cc92 /commands/partition.c
parent8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9 (diff)
downloadbarebox-3ff14ef200fc6f69b6237fffabbad796aa463cfb.tar.gz
barebox-3ff14ef200fc6f69b6237fffabbad796aa463cfb.tar.xz
various doc added
Signed-off-by: Juergen Beisert <j.beisert@pengutronix.de>
Diffstat (limited to 'commands/partition.c')
-rw-r--r--commands/partition.c31
1 files changed, 31 insertions, 0 deletions
diff --git a/commands/partition.c b/commands/partition.c
index f2b795bba..886339c97 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -21,6 +21,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief partition handling and addpart and delpart command
+ */
+
#ifdef CONFIG_ENABLE_PARTITION_NOISE
# define DEBUG
#endif
@@ -199,6 +204,26 @@ U_BOOT_CMD_START(addpart)
U_BOOT_CMD_HELP(cmd_addpart_help)
U_BOOT_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(name1)[ro],size2(name2)[ro],...
+ *
+ * \<device> is the device name under. Sizes can be given in decimal or - if
+ * prefixed with 0x - in hex. Sizes 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(cmd_tbl_t * cmdtp, int argc, char *argv[])
{
struct device_d *dev;
@@ -230,3 +255,9 @@ U_BOOT_CMD_START(delpart)
U_BOOT_CMD_HELP(cmd_delpart_help)
U_BOOT_CMD_END
+/** @page delpart_command delpart Delete a partition
+ *
+ * Usage is: delpart \<device>
+ *
+ * Delete a partition previously added to a device with addpart.
+ */