From 4c6e7a134fba3a17bbd115edb34eb5964dcb6b95 Mon Sep 17 00:00:00 2001 From: Thomas Petazzoni Date: Fri, 22 Jul 2022 22:21:45 +0200 Subject: [PATCH] docs/manual: update documentation about partition-type-uuid convention in genimage.cfg Whenever possible, we want to use the "shortcuts" provided by genimage for the partition-type-uuid values: - U for the EFI System Partition - F for FAT32 partitions - L for root filesystem partitions and other Linux filesystems In follow-up commits, we will convert existing genimage.cfg to this convention, except for the root filesystem, if the existing genimage.cfg specifies a partition-type-uuid that doesn't match the one that "L" would imply. In this case, we will keep things as-is to not break existing setups. However, for all future genimage.cfg files, we recommend to use "L" for the root filesystem. Signed-off-by: Thomas Petazzoni Signed-off-by: Yann E. MORIN --- docs/manual/writing-rules.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt index 84d8f76431..758965d80a 100644 --- a/docs/manual/writing-rules.txt +++ b/docs/manual/writing-rules.txt @@ -198,6 +198,18 @@ 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. + The +genimage.cfg+ files are the input for the genimage tool used in Buildroot to generate the final image file(i.e. sdcard.img). For further details about the _genimage_ language, refer to