From a0de415588a0c70521b48b2ff48191eef10bbff3 Mon Sep 17 00:00:00 2001 From: Andrew Marshall Date: Thu, 31 Oct 2024 09:04:11 -0400 Subject: [PATCH] nixos/zfs: improve docs for boot.zfs.devNodes option Specify more clearly how this is used, and defer to upstream docs for guidance on selecting it. --- nixos/modules/tasks/filesystems/zfs.nix | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix index 739b24c86d94..d4ed269efc6c 100644 --- a/nixos/modules/tasks/filesystems/zfs.nix +++ b/nixos/modules/tasks/filesystems/zfs.nix @@ -271,10 +271,11 @@ in type = lib.types.path; default = "/dev/disk/by-id"; description = '' - Name of directory from which to import ZFS devices. + Name of directory from which to import ZFS device, this is passed to `zpool import` + as the value of the `-d` option. - This should be a path under /dev containing stable names for all devices needed, as - import may fail if device nodes are renamed concurrently with a device failing. + For guidance on choosing this value, see + [the ZFS documentation](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/FAQ.html#selecting-dev-names-when-creating-a-pool-linux). ''; };