napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: update GS key overviews

Browse Source
This commit is contained in:
Adriaan de Groot 2022-04-22 12:46:19 +02:00
parent 03f755d168
commit a3bd0d8091
2 changed files with 46 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/branding/README.md
View File

@ -204,3 +204,22 @@ Adding the subdirectory can be done as follows:
to `.qm` files before being installed. The CMake macro's do this
automatically. For manual packaging, use `lrelease` to compile
the files.
## Global Storage keys
The following keys from the `branding.desc` file are copied into
Global Storage under a *branding* parent key:
"productName",
"version",
"shortVersion",
"versionedName",
"shortVersionedName",
"shortProductName",
"bootloaderEntryName",
"productUrl",
"supportUrl",
"knownIssuesUrl",
"releaseNotesUrl",
"donateUrl"
<!-- see Branding::s_stringEntryStrings and Branding::setGlobals() -->

40
src/modules/README.md
View File

@ -180,26 +180,40 @@ it is possible to take the whole installation-process into account
for determining the relative weights there.
## Global storage keys
## Global Storage keys
Some modules place values in global storage so that they can be referenced later by other modules or even other parts of the same module. The following table represents a partial list of the values available as well as where they originate from and which module consume them.
Some modules place values in Global Storage so that they can be referenced later by other modules or even other parts of the same module. The following table represents a partial list of the values available as well as where they originate from and which module consume them.
Keys whose name is followed by a `+` are **structured** data, and have
entries (which start with `+`) below the parent key describing subkeys.
Some structured keys refer to other documentation sources.
Key |Source |Consumers|Description
------------------|----------------|---|---
btrfsSubvolumes |mount |fstab|List of maps containing the mountpoint and btrtfs subvolume
Key |Source |Consumers |Description
------------------|----------------|---------------|---
bootloader + |partition | |Bootloader location
\+ installPath | | |Device (e.g. `/dev/sda`) where the bootloader is installed
branding + | | |See `src/branding/README.md`
btrfsSubvolumes |mount |fstab |List of maps containing the mountpoint and btrtfs subvolume
btrfsRootSubvolume|mount |bootloader, luksopenswaphook|String containing the subvolume mounted at root
efiSystemPartition|partition |bootloader, fstab|String containing the path to the ESP relative to the installed system
extraMounts |mount |unpackfs|List of maps holding metadata for the temporary mountpoints used by the installer
fullname |users ||The full username (e.g. "Jane Q. Public")
hostname |users ||A string containing the hostname of the new system
netinstallAdd |packagechooser |netinstall|Data to add to netinstall tree. Same format as netinstall.yaml
netinstallSelect |packagechooser |netinstall|List of group names to select in the netinstall tree
partitions |partition, rawfs|numerous modules|List of maps of metadata about each partition
rootMountPoint |mount |numerous modules|A string with the absolute path to the root mountpoint
fullname |users | |The full username (e.g. "Jane Q. Public")
hostname |users | |A string containing the hostname of the new system
netinstallAdd |packagechooser |netinstall |Data to add to netinstall tree. Same format as netinstall.yaml
netinstallSelect |packagechooser |netinstall |List of group names to select in the netinstall tree
packageOperations +|packagechooser, netinstall|packages|Operations to perform
\+ (list data) | | |See `packages.conf`
partitions + |partition, rawfs|(many) |List of maps of metadata about each partition
\+ device | | |path to the partition device
\+ fs | | |the name of the file system
\+ mountPoint | | |where the device should be mounted
\+ uuid | | |the UUID of the partition device
rootMountPoint |mount |(many) |A string with the absolute path to the root mountpoint
username |users |networkcfg, plasmainf, preservefiles|A string containing the username of the new user
zfsDatasets |zfs |bootloader, grubcfg, mount|List of maps of zfs datasets including the name and mount information
zfsInfo |partition |mount, zfs|List of encrypted zfs partitions and the encription info
zfsPoolInfo |zfs |mount, umount|List of maps of zfs pool info including the name and mountpoint
zfsInfo |partition |mount, zfs |List of encrypted zfs partitions and the encription info
zfsPoolInfo |zfs |mount, umount |List of maps of zfs pool info including the name and mountpoint
## C++ modules