diff options
| author | Alyssa Ross <hi@alyssa.is> | 2021-11-27 12:10:38 +0000 |
|---|---|---|
| committer | Luca Boccassi <luca.boccassi@gmail.com> | 2021-11-27 13:46:35 +0000 |
| commit | f000edf9ea17222d503ba5fb8972e6e5a27c745b (patch) | |
| tree | e38d76d8e316a039e19579ccb5927d1b3a686129 /tools | |
| parent | f5caacec1c5b5701ba1d17f75983bf27aad54d7e (diff) | |
| download | systemd-f000edf9ea17222d503ba5fb8972e6e5a27c745b.tar.gz | |
docs: fix descriptions in discoverable partitions
00db9a114e ("docs: generate table from header using a script") got the
descriptions for the partition types mixed up. After that change, the
spec claimed, for example, that the /usr partition should contain
"dm-verity integrity hash data for the matching root partition", and
that the /usr verity partition should be of type "Any native, optionally
in LUKS". This made the spec an extremely confusing read before I
figured out what must have happened!
I've gone through the table as it existed prior to 00db9a114e, and moved
the descriptions around in the script that generates the table until
they matched up with what they used to be. Then I regenerated the
table from the fixed script.
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/list-discoverable-partitions.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/tools/list-discoverable-partitions.py b/tools/list-discoverable-partitions.py index 0d653f8186..57b99b2a49 100644 --- a/tools/list-discoverable-partitions.py +++ b/tools/list-discoverable-partitions.py @@ -58,21 +58,21 @@ DESCRIPTIONS = { 'If the partition is encrypted with LUKS or has dm-verity integrity data (see below), the ' 'device mapper file will be named `/dev/mapper/root`.'), 'USR': ( + 'Any native, optionally in LUKS', + 'Similar semantics to root partition, but just the `/usr/` partition.'), + 'ROOT_VERITY': ( 'A dm-verity superblock followed by hash data', 'Contains dm-verity integrity hash data for the matching root partition. If this feature is ' 'used the partition UUID of the root partition should be the first 128 bits of the root hash ' 'of the dm-verity hash data, and the partition UUID of this dm-verity partition should be the ' 'final 128 bits of it, so that the root partition and its Verity partition can be discovered ' 'easily, simply by specifying the root hash.'), - 'ROOT_VERITY': ( - 'A serialized JSON object, see below', - 'Contains a root hash and a PKCS#7 signature for it, permitting signed dm-verity GPT images.'), 'USR_VERITY': ( - 'Any native, optionally in LUKS', - 'Similar semantics to root partition, but just the `/usr/` partition.'), - 'ROOT_VERITY_SIG': ( 'A dm-verity superblock followed by hash data', 'Similar semantics to root Verity partition, but just for the `/usr/` partition.'), + 'ROOT_VERITY_SIG': ( + 'A serialized JSON object, see below', + 'Contains a root hash and a PKCS#7 signature for it, permitting signed dm-verity GPT images.'), 'USR_VERITY_SIG': ( 'A serialized JSON object, see below', 'Similar semantics to root Verity signature partition, but just for the `/usr/` partition.'), |