[PATCH v2 1/4] doc: man-page for the part command

[Heinrich Schuchardt]

On 12/22/22 11:30, Enric Balletbo i Serra wrote:
> Provide a man-page for the part command.
>
> Signed-off-by: Enric Balletbo i Serra <eballetbo at redhat.com>
> ---
>
> Changes in v2:
>   - New patch (1) in the series to fix a trivial type
>   - New patch (2) in the series to introduce the documentation of the
>     part type command
>   - Fix typo s/partittion/partition/ in commit message
>   - Add gpt test for the part type command
>   - Add the man-page for part command in doc/usage/cmd
>
>   doc/usage/cmd/part.rst | 97 ++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 97 insertions(+)
>   create mode 100644 doc/usage/cmd/part.rst
>
> diff --git a/doc/usage/cmd/part.rst b/doc/usage/cmd/part.rst
> new file mode 100644
> index 0000000000..be931e520f
> --- /dev/null
> +++ b/doc/usage/cmd/part.rst

Thanks for providing this man-page.

The patch lacks an entry in doc/usage/cmd/index.rst.

> @@ -0,0 +1,97 @@
> +.. 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' 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' 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' sets an environment variable to the partition number using the partition name,
> +part must be specified as partition name.
> +
> +    interfaceH
> +        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.
> +
> +Example
> +-------
> +
> +This example shows listing supported partition types::
> +
> +   U-Boot> part types
> +   Supported partition tables: EFI, AMIGA, DOS, ISO, MAC

Please, provide examples for the other sub-commands too.

> +
> +Return value
> +------------
> +
> +The return value $? is always 0 (true).

1 (false) is returned in case of errors. Please, have a look at the code.

Best regards

Heinrich