⏳ @eshanized updated the repository!!!

calamares/modules/machineid.conf

@@ -1,3 +1,56 @@
+# SPDX-FileCopyrightText: no
+# SPDX-License-Identifier: CC0-1.0
+#
+# 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.
+# The default is *false*.
 systemd: true
+# If systemd is true, the kind of /etc/machine-id to create in the target
+#  - uuid (default) generates a UUID
+#  - systemd alias of uuid
+#  - blank creates the file but leaves it empty at 0 bytes
+#  - none alias of blank (use `systemd: false` if you don't want one at all)
+#  - literal-uninitialized creates the file and writes the string "uninitialized\n"
+# systemd-style: uuid
+
+# Whether to create /var/lib/dbus/machine-id for D-Bus.
+# The default is *false*.
 dbus: true
+# 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).
+# The default is *false*.
 dbus-symlink: true
+
+# Copy entropy from the host? If this is set to *true*, then
+# any entropy file listed below will be copied from the host
+# if it exists. Non-existent files will be generated from
+# /dev/urandom . The default is *false*.
+# entropy-copy: false
+# Which files to write (paths in the target). Each of these files is
+# either generated from /dev/urandom or copied from the host, depending
+# on the setting for *entropy-copy*, above.
+# entropy-files:
+#     - /var/lib/urandom/random-seed
+#     - /var/lib/systemd/random-seed
+
+# Whether to create an entropy file /var/lib/urandom/random-seed
+#
+# DEPRECATED: list the file in entropy-files instead. If this key
+# exists and is set to *true*, a warning is printed and Calamares
+# behaves as if `/var/lib/urandom/random-seed` is listed in *entropy-files*.
+#
+# entropy: false
+
+# Whether to create a symlink for D-Bus
+#
+# DEPRECATED: set *dbus-symlink* with the same meaning instead.
+#
+# symlink: false

calamares/modules/mount.conf

@@ -1,3 +1,23 @@
+# SPDX-FileCopyrightText: no
+# SPDX-License-Identifier: CC0-1.0
+#
+# Mount filesystems in the target (generally, before treating the
+# target as a usable chroot / "live" system). Filesystems are
+# automatically mounted from the partitioning module. Filesystems
+# listed here are **extra**. The filesystems listed in *extraMounts*
+# are mounted in all target systems.
+---
+# Extra filesystems to mount. The key's value is a list of entries; each
+# entry has five keys:
+#   - device    The device node to mount
+#   - fs (optional) The filesystem type to use
+#   - mountPoint Where to mount the filesystem
+#   - options (optional) An array of options to pass to mount
+#   - efi (optional) A boolean that when true is only mounted for UEFI installs
+#
+# The device is not mounted if the mountPoint is unset or if the fs is
+# set to unformatted.
+#
 extraMounts:
     - device: proc
       fs: proc
@@ -19,30 +39,86 @@ extraMounts:
       mountPoint: /sys/firmware/efi/efivars
       efi: true
 
+# Btrfs subvolumes to create if root filesystem is on btrfs volume.
+# If *mountpoint* is mounted already to another partition, it is ignored.
+# Separate subvolume for swapfile is handled separately and automatically.
+#
+# It is possible to prevent subvolume creation -- this is likely only relevant
+# for the root (/) subvolume -- by giving an empty string as a subvolume
+# name. In this case no subvolume will be created.
+#
 btrfsSubvolumes:
     - mountPoint: /
       subvolume: /@
+      # As an alternative:
+      #
+      # subvolume: ""
     - mountPoint: /home
       subvolume: /@home
-    - mountPoint: /root
-      subvolume: /@root
-    - mountPoint: /srv
-      subvolume: /@srv
     - mountPoint: /var/cache
       subvolume: /@cache
     - mountPoint: /var/log
       subvolume: /@log
-    - mountPoint: /var/tmp
-      subvolume: /@tmp
 
+# The name of the btrfs subvolume holding the swapfile.  This only used when
+# a swapfile is selected and the root filesystem is btrfs
+#
 btrfsSwapSubvol: /@swap
 
+# The mount options used to mount each filesystem.
+#
+# filesystem contains the name of the filesystem or on of three special
+# values, "default", efi" and "btrfs_swap".  The logic is applied in this manner:
+#   - If the partition is the EFI partition, the "efi" entry will be used
+#   - If the fs is btrfs and the subvolume is for the swapfile,
+#     the "btrfs_swap" entry is used
+#   - If the  filesystem is an exact match for filesystem, that entry is used
+#   - If no match is found in the above, the default entry is used
+#   - If there is no match and no default entry, "defaults" is used
+#   - If the mountOptions key is not present, "defaults" is used
+#
+# Each filesystem entry contains 3 keys, all of which are optional
+#   options - An array of mount options that is used on all disk types
+#   ssdOptions - An array of mount options combined with options for ssds
+#   hddOptions - An array of mount options combined with options for hdds
+# If combining these options results in an empty array, "defaults" is used
+#
+# Example 1
+# In this example, there are specific options for ext4 and btrfs filesystems,
+# the EFI partition and the subvolume holding the btrfs swapfile.  All other
+# filesystems use the default entry.  For the btrfs filesystem, there are
+# additional options specific to hdds and ssds
+#
+# mountOptions:
+#    - filesystem: default
+#      options: [ defaults ]
+#    - filesystem: efi
+#      options: [ defaults, umask=0077 ]
+#    - filesystem: ext4
+#      options: [ defaults ]
+#    - filesystem: btrfs
+#      options: [ defaults, compress=zstd:1 ]
+#      ssdOptions: [ discard=async ]
+#      hddOptions: [ autodefrag ]
+#    - filesystem: btrfs_swap
+#      options: [ defaults, noatime ]
+#
+# Example 2
+# In this example there is a single default used by all filesystems
+#
+# mountOptions:
+#    - filesystem: default
+#      options: [ defaults ]
+#
 mountOptions:
     - filesystem: default
-      options: [ defaults, noatime ]
+      options: [ defaults ]
     - filesystem: efi
       options: [ defaults, umask=0077 ]
     - filesystem: btrfs
-      options: [ defaults, noatime, compress=zstd ]
+      options: [ defaults, compress=zstd:1 ]
     - filesystem: btrfs_swap
       options: [ defaults, noatime ]
+
+
+