Re: [PATCH v1 7/7] doc: android: avb: add slot_suffix param details

[Mattijs Korpershoek <mkorpershoek@baylibre.com>]

Hi Igor,

Thank you for the patch.

On mar., févr. 06, 2024 at 23:31, Igor Opaniuk <igor.opaniuk@foundries.io> wrote:

> From: Igor Opaniuk <igor.opaniuk@gmail.com>
>
> Add info about slot_suffix param for avb verify.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@gmail.com>
> ---
>
>  doc/android/avb2.rst | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
>
> diff --git a/doc/android/avb2.rst b/doc/android/avb2.rst
> index a072119574f..c0b2bedb831 100644
> --- a/doc/android/avb2.rst
> +++ b/doc/android/avb2.rst
> @@ -39,15 +39,17 @@ Provides CLI interface to invoke AVB 2.0 verification + misc. commands for
>  different testing purposes::
>  
>      avb init <dev> - initialize avb 2.0 for <dev>
> -    avb verify - run verification process using hash data from vbmeta structure
> +    avb verify [slot_suffix] - run verification process using hash data
> +        from vbmeta structure. Provide [slot_suffix] if vbmeta partition
> +        is slotted

Any particular reason for this to not be exactly the wording as in cmd/avb.c?

	"avb verify [slot_suffix] - run verification process using hash data\n"
	"    from vbmeta structure\n"
	"    [slot_suffix] - _a, _b, etc (if vbmeta partition is slotted)\n"

It looks good, but I think it would be better if both are the same for
consistency, since both texts are user facing.

>      avb read_rb <num> - read rollback index at location <num>
>      avb write_rb <num> <rb> - write rollback index <rb> to <num>
>      avb is_unlocked - returns unlock status of the device
>      avb get_uuid <partname> - read and print uuid of partition <partname>
>      avb read_part <partname> <offset> <num> <addr> - read <num> bytes from
> -    partition <partname> to buffer <addr>
> +        partition <partname> to buffer <addr>
>      avb write_part <partname> <offset> <num> <addr> - write <num> bytes to
> -    <partname> by <offset> using data from <addr>
> +        <partname> by <offset> using data from <addr>
>  
>  Partitions tampering (example)
>  ------------------------------
> -- 
> 2.34.1