Browse Source

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 <thomas.petazzoni@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Thomas Petazzoni 3 years ago
parent
commit
4c6e7a134f
1 changed files with 12 additions and 0 deletions
  1. 12 0
      docs/manual/writing-rules.txt

+ 12 - 0
docs/manual/writing-rules.txt

@@ -198,6 +198,18 @@ image sdimage.img {
   chance, the byte count.  In comments instead use +GB+, +MB+, +KB+
   chance, the byte count.  In comments instead use +GB+, +MB+, +KB+
   (not +kb+) in place of +G+, +M+, +K+.
   (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
 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
 Buildroot to generate the final image file(i.e. sdcard.img). For further
 details about the _genimage_ language, refer to
 details about the _genimage_ language, refer to