Re: [Buildroot] [PATCH 01/17] docs/manual/writing-rules: add shortcuts for genimage partition-type-uuid

[Niklas Cassel via buildroot <buildroot@buildroot.org>]

Hello Brandon,

On Sat, Nov 09, 2024 at 04:16:15PM -0600, Brandon Maier wrote:
> Prefer the use of genimage partition-type-uuid shortcuts over using the
> full GUID. To make shortcuts easier to find, include a link to the full
> list in the genimage source.
> 
> Signed-off-by: Brandon Maier <brandon.maier@gmail.com>
> ---
>  docs/manual/writing-rules.adoc | 28 +++++++++++++++++-----------
>  1 file changed, 17 insertions(+), 11 deletions(-)
> 
> diff --git a/docs/manual/writing-rules.adoc b/docs/manual/writing-rules.adoc
> index 03e4f2c61cfe4820fe6d06d193b9215d423bf4d7..10f25a7011db2f8d4ea7c4acb3ea66c4dcce7a86 100644
> --- a/docs/manual/writing-rules.adoc
> +++ b/docs/manual/writing-rules.adoc
> @@ -198,17 +198,23 @@ image sdimage.img {
>    chance, the byte count.  In comments instead use +GB+, +MB+, +KB+
>    (not +kb+) in place of +G+, +M+, +K+.
>  
> -* For GPT partitions, the +partition-type-uuid+ value must be +U+ for
> -  the EFI System Partition (expanded to
> -  +c12a7328-f81f-11d2-ba4b-00a0c93ec93b+ by _genimage_), +F+ for a FAT
> -  partition (expanded to +ebd0a0a2-b9e5-4433-87c0-68b6b72699c7+ by
> -  _genimage_) or +L+ for the root filesystem or other filesystems
> -  (expanded to +0fc63daf-8483-4772-8e79-3d69d8477de4+ by
> -  _genimage_). Even though +L+ is the default value of _genimage_, we
> -  prefer to have it explicitly specified in our +genimage.cfg+
> -  files. Finally, these shortcuts should be used without double
> -  quotes, e.g +partition-type-uuid = U+. If an explicit GUID is
> -  specified, lower-case letters should be used.
> +* For GPT partitions, the +partition-type-uuid+ value must use a GUID shortcut
> +  if it is supported by genimage. These shortcuts should be used without double
> +  quotes, e.g +partition-type-uuid = U+. If an explicit GUID is specified,
> +  lower-case letters should be used. Even though the shortcut +L+ is the
> +  default value of _genimage_, we prefer to have it explicitly specified in our
> +  +genimage.cfg+ files. Some common shortcuts are provided below, for the full
> +  list see the +gpt_partition_type_shortcuts+ table in
> +  https://github.com/pengutronix/genimage/blob/master/image-hd.c[].

Like you wrote in the cover letter, this series is only partially
implementing Thomas' suggestion, which was:
"My point is that we want *consistency*. So either we use "L" for all
rootfs partitions. Or we use root-${ARCH} for all rootfs partitions."


While this series is just converting GUIDs to use a shortcut, if there is
one available, I still think that we can update the documentation to be
even stricter, something like:

"For the rootfs partition, the partition type GUID should be set to the
architecture-specific shortcut (e.g. root-arm64), rather than the generic
+L+ shortcut (generic Linux rootfs). An explicit partition type GUID should
always be specified for the rootfs partition."


That way we can remove:
"Even though the shortcut +L+ is the default value of _genimage_,
we prefer to have it explicitly specified in our +genimage.cfg+ files."

I don't like this sentence, because it could be interpreted as that
buildroot prefers to have the GUID explicitly specified (rather than
having the shortcut explicitly specified).



Kind regards,
Niklas
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot