summary refs log tree commit diff
path: root/Documentation/development/uuid-reference.adoc
blob: 5247726395fff704a8e53bd1efbd60df563facd1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
= UUID Reference
:page-parent: Development
:page-nav_order: 6

// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0

https://en.wikipedia.org/wiki/Universally_unique_identifier[UUIDs] are
used extensively throughout Spectrum.  When encountering a UUID in the
codebase, it can be difficult to understand what exactly the UUID
means, and where it originates from -- is it from some standard, or
Spectrum-specific?

To solve this problem, this reference documents all of the UUIDs used
in Spectrum.

== https://en.wikipedia.org/wiki/GUID_Partition_Table[GPT] Partition Types

=== `c12a7328-f81f-11d2-ba4b-00a0c93ec93b`

"EFI System Partition", from the https://uefi.org/specifications[UEFI
Specification].

=== `4f68bce3-e8cd-4db1-96e7-fbcaf984b709`

"Root Partition (amd64/x86_64)" from the
https://uapi-group.org/specifications/specs/discoverable_partitions_specification/[Discoverable Partitions
Specification].

=== `2c7357ed-ebd2-46d9-aec1-23d437ec2bf5`

"Root Verity Partition (amd64/x86_64)" from the
https://uapi-group.org/specifications/specs/discoverable_partitions_specification/[Discoverable Partitions
Specification].

=== `9293e1ff-cee4-4658-88be-898ec863944f`

xref:user-partition.adoc[Spectrum user partition].

=== `56a3bbc3-aefa-43d9-a64d-7b3fd59bbc4e`

https://github.com/endlessm/eos-installer["eosimages"] partition on the
Spectrum combined live system / installer image.

== Combined Image Partition IDs

These UUIDs are used as the unique partition identifiers for the
Spectrum combined live system / installer image.

=== `6e23b026-9f1e-479d-8a58-a0cda382e1ce`

The Spectrum installer system.

'''

== Finding Undocumented UUIDs

Running the `Documentation/scripts/undocumented-uuids.sh` script from
the root of the Spectrum repository will scan the entire tree for
UUIDs not mentioned in this document.