[machineid] Improve documentation on this module

- document module's purpose
 - document existing configurations
 - deprecate "symlink" and introduce more-accurate "dbus-symlink"
 - add new configurations for upcoming entropy file
This commit is contained in:
Adriaan de Groot 2019-10-01 14:13:01 +02:00
parent 4c0719d95d
commit 3ae5a3db76

View File

@ -1,8 +1,24 @@
# Machine-ID and other random data on the target system.
#
# This module can create a number of "random" things on the target:
# - a systemd machine-id file (hence the name of the Calamares module)
# with a random UUID.
# - a dbus machine-id file (or, optionally, link to the one from systemd)
# - an entropy file
#
--- ---
# Whether to create /etc/machine-id for systemd. # Whether to create /etc/machine-id for systemd.
systemd: true systemd: true
# Whether to create /var/lib/dbus/machine-id for D-Bus. # Whether to create /var/lib/dbus/machine-id for D-Bus.
dbus: true dbus: true
# Whether /var/lib/dbus/machine-id should be a symlink to /etc/machine-id # Whether /var/lib/dbus/machine-id should be a symlink to /etc/machine-id
# (ignored if dbus is false, or if there is no /etc/machine-id to point to). # (ignored if dbus is false, or if there is no /etc/machine-id to point to).
dbus-symlink: true
# this is a deprecated form of *dbus-symlink*
symlink: true symlink: true
# Whether to create an entropy file
entropy: false
# Whether to copy entropy from the host
entropy-copy: false