patches and low-level development discussion
 help / color / mirror / code / Atom feed
blob 16279c8a7e690bbaafdc3e0194f3130ba65c281c 2421 bytes (raw)
name: Documentation/doc/development/uuid-reference.adoc 	 # note: path name is non-authoritative(*)

 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
= 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].

=== `b921b045-1df0-41c3-af44-4c6f280d3fae`

"Root Partition (64-bit ARM/AArch64)" from the
https://uapi-group.org/specifications/specs/discoverable_partitions_specification/[Discoverable Partitions
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].

=== `df3300ce-d69f-4c92-978c-9bfb0f38d820`

"Root Verity Partition (64-bit ARM/AArch64)" 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].

=== `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.

=== `18f2ccff-92f1-4bb1-a80e-24f76ecda90c`

The not-yet-used B verity partition.

=== `ec0c5ff3-f6b1-4adf-82b4-61336c4d135f`

The not-yet-used B root filesystem partition.

'''

== 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.

debug log:

solving 16279c8 ...
found 16279c8 in https://spectrum-os.org/git/spectrum

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).