[pve-devel] [PATCH docs] installation: document advanced btrfs options

[Christoph Heiss]

Also includes the new `compress` option that has been recently
introduced in the installer.

Signed-off-by: Christoph Heiss <c.heiss at proxmox.com>
---
The `compress` option will only be included starting with the next (8.3)
ISO release, FWIW. 

I can leave it out for later if preferred, but a newer pve-docs will
probably not bumped/hit the repos until the next release, I'd guess?

 pve-installation.adoc | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index d292895..6109b35 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -349,6 +349,25 @@ on the hard disk(s) for further partitioning (for example to create a
 swap-partition). `hdsize` is only honored for bootable disks, that is only the
 first disk or mirror for RAID0, RAID1 or RAID10, and all disks in RAID-Z[123].
 
+[[advanced_btrfs_options]]
+Advanced BTRFS Configuration Options
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+No swap space is created when BTRFS is used but you can reserve some
+unpartitioned space on the install disks for swap. You can either create a
+separate partition, BTRFS subvolume or a swapfile using the `btrfs filesystem
+mkswapfile` command.
+
+`compress`::
+
+Defines whether compression is enabled for the BTRFS subvolume. Different
+compression algorithms are supported: 'on' (equivalent to 'zlib'), 'zlib', 'lzo'
+and 'zstd'. Defaults to 'off'.
+
+`hdsize`::
+
+Defines the total hard disk size to be used. This is useful to save free space
+on the hard disk(s) for further partitioning (for example, to create a
+swap partition).
 
 ZFS Performance Tips
 ~~~~~~~~~~~~~~~~~~~~
-- 
2.47.0