summary refs log tree commit diff
path: root/nixos/modules/services/computing/slurm/slurm.nix
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2021-12-05 22:06:49 +0100
committerpennae <github@quasiparticle.net>2021-12-09 01:38:24 +0100
commit2d564521c094b17e88707ac95cb4b6331b1b709a (patch)
tree39be0a04a8835f7682dd70aae57d85ca46db7c3d /nixos/modules/services/computing/slurm/slurm.nix
parent6eaf4f90c2b25918109fb2689d56e33a4f59f37d (diff)
downloadnixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.gz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.bz2
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.lz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.xz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.zst
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.zip
treewide: add literalDocBook text to options with complex defaults
some options have default that are best described in prose, such as
defaults that depend on the system stateVersion, defaults that are
derivations specific to the surrounding context, or those where the
expression is much longer and harder to understand than a simple text
snippet.
Diffstat (limited to 'nixos/modules/services/computing/slurm/slurm.nix')
-rw-r--r--nixos/modules/services/computing/slurm/slurm.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/nixos/modules/services/computing/slurm/slurm.nix b/nixos/modules/services/computing/slurm/slurm.nix
index 02dfe2fe882..aa0be8726f0 100644
--- a/nixos/modules/services/computing/slurm/slurm.nix
+++ b/nixos/modules/services/computing/slurm/slurm.nix
@@ -281,6 +281,10 @@ in
         type = types.path;
         internal = true;
         default = etcSlurm;
+        defaultText = literalDocBook ''
+          Directory created from generated config files and
+          <literal>config.${opt.extraConfigPaths}</literal>.
+        '';
         description = ''
           Path to directory with slurm config files. This option is set by default from the
           Slurm module and is meant to make the Slurm config file available to other modules.