From 96ccf256b207fa3f41dae816d31b4686b492ec1c Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Thu, 2 Dec 2021 22:02:14 +0100 Subject: [PATCH] [mount] Add documentation to the config file --- src/modules/mount/mount.conf | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/modules/mount/mount.conf b/src/modules/mount/mount.conf index 6168e97cc..84dca05a7 100644 --- a/src/modules/mount/mount.conf +++ b/src/modules/mount/mount.conf @@ -42,15 +42,24 @@ extraMountsEfi: mountPoint: /sys/firmware/efi/efivars # Btrfs subvolumes to create if root filesystem is on btrfs volume. -# If mountpoint is mounted already to another partition, it is ignored. +# 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. When using snapper as +# a rollback mechanism, it is recommended to **not** create a subvolume +# for root. btrfsSubvolumes: - mountPoint: / subvolume: /@ + # As an alternative: + # + # subvolume: "" - mountPoint: /home subvolume: /@home - mountPoint: /var/cache subvolume: /@cache - mountPoint: /var/log - subvolume: /@log \ No newline at end of file + subvolume: /@log