doc: man-page for the part command

Provide a man-page for the part command.

Signed-off-by: Enric Balletbo i Serra <eballetbo@redhat.com>
This commit is contained in:
Enric Balletbo i Serra
2023-01-10 17:19:32 +01:00
committed by Tom Rini
parent 3aad58a072
commit ff6ef4b909
2 changed files with 137 additions and 0 deletions

136
doc/usage/cmd/part.rst Normal file
View File

@@ -0,0 +1,136 @@
.. SPDX-License-Identifier: GPL-2.0+:
part command
===============
Synopis
-------
::
part uuid <interface> <dev>:<part> [varname]
part list <interface> <dev> [flags] [varname]
part start <interface> <dev> <part> <varname>
part size <interface> <dev> <part> <varname>
part number <interface> <dev> <part> <varname>
part types
Description
-----------
The `part` command is used to manage disk partition related commands.
The 'part uuid' command prints or sets an environment variable to partition UUID
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number
varname
an optional environment variable to store the current partition UUID value into.
The 'part list' command prints or sets an environment variable to the list of partitions
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number
flags
-bootable
lists only bootable partitions
varname
an optional environment variable to store the list of partitions value into.
The 'part start' commnad sets an environment variable to the start of the partition (in blocks),
part can be either partition number or partition name.
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number
varname
a variable to store the current start of the partition value into.
The 'part size' command sets an environment variable to the size of the partition (in blocks),
part can be either partition number or partition name.
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number
varname
a variable to store the current size of the partition value into.
The 'part number' command sets an environment variable to the partition number using the partition name,
part must be specified as partition name.
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number
varname
a variable to store the current partition number value into
The 'part types' command list supported partition table types.
Examples
--------
::
=> host bind 0 ./test_gpt_disk_image.bin
=> part uuid host 0:1
24156b69-3378-497f-bb3e-b982223de528
=> part uuid host 0:1 varname
=> env print varname
varname=24156b69-3378-497f-bb3e-b982223de528
=>
=> part list host 0
Partition Map for HOST device 0 -- Partition Type: EFI
Part Start LBA End LBA Name
Attributes
Type GUID
Partition GUID
1 0x00000800 0x00000fff "second"
attrs: 0x0000000000000000
type: ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
(data)
guid: 24156b69-3378-497f-bb3e-b982223de528
2 0x00001000 0x00001bff "first"
attrs: 0x0000000000000000
type: ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
(data)
guid: 5272ee44-29ab-4d46-af6c-4b45ac67d3b7
=>
=> part start host 0 2 varname
=> env print varname
varname=1000
=>
=> part size host 0 2 varname
=> env print varname
varname=c00
=>
=> part number host 0 2 varname
=> env print varname
varname=0x2
=>
=> part types
Supported partition tables: EFI, AMIGA, DOS, ISO, MAC
Return value
------------
The return value $? is set to 0 (true) if the command succededd. If an
error occurs, the return value $? is set to 1 (false).

View File

@@ -61,6 +61,7 @@ Shell commands
cmd/mbr
cmd/md
cmd/mmc
cmd/part
cmd/pause
cmd/pinmux
cmd/printenv