]> git.proxmox.com Git - mirror_zfs.git/commitdiff
zfs-create(8): ZFS for swap: caution, clarity
authorGraham Perrin <grahamperrin@gmail.com>
Fri, 2 Jun 2023 18:25:13 +0000 (19:25 +0100)
committerGitHub <noreply@github.com>
Fri, 2 Jun 2023 18:25:13 +0000 (11:25 -0700)
Make the section heading more generic (the section relates to ZFS files
as well as ZFS volumes).

Swapping to a ZFS volume is prone to deadlock. Remove the related
instruction, direct readers to OpenZFS FAQ. Related, but not linked
from within the manual page:

<https://openzfs.github.io/openzfs-docs/Project%20and%20Community/FAQ.html#using-a-zvol-for-a-swap-device-on-linux>
(Using a zvol for a swap device on Linux).

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Graham Perrin <grahamperrin@freebsd.org>
Issue #7734
Closes #14756

man/man8/zfs-create.8

index a7b6097c37f120ce3bf04ab96a4550fbf2443b04..b3997d32767cbb3fcbc9906a87e0713ecb8d87e7 100644 (file)
@@ -234,14 +234,11 @@ if the volume is not sparse.
 Print verbose information about the created dataset.
 .El
 .El
-.Ss ZFS Volumes as Swap
-ZFS volumes may be used as swap devices.
-After creating the volume with the
-.Nm zfs Cm create Fl V
-enable the swap area using the
-.Xr swapon 8
-command.
-Swapping to files on ZFS filesystems is not supported.
+.Ss ZFS for Swap
+Swapping to a ZFS volume is prone to deadlock and not recommended.
+See OpenZFS FAQ.
+.Pp
+Swapping to a file on a ZFS filesystem is not supported.
 .
 .Sh EXAMPLES
 .\" These are, respectively, examples 1, 10 from zfs.8