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

[grubcfg] Update documentation of config file

Browse Source 
- add some more general description
 - document new-to-implement *keepDistributor* flag

SEE #1201
This commit is contained in:
Adriaan de Groot 2019-11-04 11:05:18 +01:00
parent ffbc1a3e7d
commit aae7d7dd0a
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/modules/grubcfg/grubcfg.conf
View File

@ -1,9 +1,12 @@
# Create, overwrite or update /etc/default/grub in the target system.
#
# Write lines to /etc/default/grub (in the target system) based # Write lines to /etc/default/grub (in the target system) based
# on calculated values and the values set in the *defaults* key # on calculated values and the values set in the *defaults* key
# in this configuration file. # in this configuration file.
# #
# Calculated values are: # Calculated values are:
# - GRUB_DISTRIBUTOR, branding module, *bootloaderEntryName* # - GRUB_DISTRIBUTOR, branding module, *bootloaderEntryName* (this
# string is sanitized, and see also setting *keepDistributor*)
# - GRUB_ENABLE_CRYPTODISK, based on the presence of filesystems # - GRUB_ENABLE_CRYPTODISK, based on the presence of filesystems
# that use LUKS # that use LUKS
# - GRUB_CMDLINE_LINUX_DEFAULT, adding LUKS setup and plymouth # - GRUB_CMDLINE_LINUX_DEFAULT, adding LUKS setup and plymouth
@ -14,6 +17,12 @@
# already existed. If set to false, edits the existing file instead. # already existed. If set to false, edits the existing file instead.
overwrite: false overwrite: false
# If set to true, an **existing** setting for GRUB_DISTRIBUTOR is
# kept, not updated to the *bootloaderEntryName* from the branding file.
# Use this if the GRUB_DISTRIBUTOR setting in the file is "smart" in
# some way (e.g. uses shell-command substitution).
keepDistributor: false
# Default entries to write to /etc/default/grub if it does not exist yet or if # Default entries to write to /etc/default/grub if it does not exist yet or if
# we are overwriting it. # we are overwriting it.
# #