Hi Sumit,

On 2026-09-28T06:40:33, Sumit Singh Dhami <[email protected]> wrote:
> doc: gpt: document 'attrs' key and gpt_partition_attrs var
>
> Document the 'attrs=<VALUE>' key of the 'gpt write' partition list in
> doc/README.gpt and doc/usage/cmd/gpt.rst. Document the
> gpt_partition_attrs variable set by 'gpt setenv'. Update the example
> partition list and output to show 'attrs=' usage.

Documentation normally goes in the same patch as the feature it
describes, so the attrs= parts belong in patch 4 and the
gpt_partition_attrs parts in patch 5. That keeps each patch
self-contained. What do you think?

>
> Signed-off-by: Sumit Singh Dhami <[email protected]>
>
> doc/README.gpt        | 11 +++++++++++
>  doc/usage/cmd/gpt.rst | 11 ++++++++++-
>  2 files changed, 21 insertions(+), 1 deletion(-)

> diff --git a/doc/usage/cmd/gpt.rst b/doc/usage/cmd/gpt.rst
> @@ -56,6 +56,7 @@ partition string
> +    * attrs=<VALUE> - The GPT partition attributes, optional if 
> CONFIG_PARTITION_ATTR=y is enabled

Not quite. The uuid line says "optional if ..." because the uuid
becomes optional when CONFIG_RANDOM_UUID is enabled. Here attrs is
always optional but only does anything with CONFIG_PARTITION_ATTR, so
it should follow the type line instead, e.g. "The full 64-bit GPT
partition attributes, requires CONFIG_PARTITION_ATTR=y". It is also
worth mentioning here (as README.gpt does) that the bootable flag is
still ORed in on top of whatever value is given, since that is easy to
trip over.

Regards,
Simon

Reply via email to