nixos/*: literalDocBook -> literalMD

no change to rendered output

pennae 51a11254 169072fb

Changed files
+48 -47
nixos
modules
config
misc
programs
services
audio
cluster
kubernetes
computing
slurm
continuous-integration
buildbot
hercules-ci-agent
games
misc
monitoring
networking
web-apps
web-servers
lighttpd
trafficserver
x11
display-managers
system
tasks
filesystems
virtualisation
+1 -1
nixos/modules/config/networking.nix
···
networking.hostFiles = lib.mkOption {
type = types.listOf types.path;
-
defaultText = literalDocBook "Hosts from <option>networking.hosts</option> and <option>networking.extraHosts</option>";
example = literalExpression ''[ "''${pkgs.my-blocklist-package}/share/my-blocklist/hosts" ]'';
description = lib.mdDoc ''
Files that should be concatenated together to form {file}`/etc/hosts`.
···
networking.hostFiles = lib.mkOption {
type = types.listOf types.path;
+
defaultText = literalMD "Hosts from {option}`networking.hosts` and {option}`networking.extraHosts`";
example = literalExpression ''[ "''${pkgs.my-blocklist-package}/share/my-blocklist/hosts" ]'';
description = lib.mdDoc ''
Files that should be concatenated together to form {file}`/etc/hosts`.
+4 -3
nixos/modules/config/system-path.nix
···
defaultPackages = mkOption {
type = types.listOf types.package;
default = defaultPackages;
-
defaultText = literalDocBook ''
-
these packages, with their <literal>meta.priority</literal> numerically increased
(thus lowering their installation priority):
-
<programlisting>${defaultPackagesText}</programlisting>
'';
example = [];
description = lib.mdDoc ''
···
defaultPackages = mkOption {
type = types.listOf types.package;
default = defaultPackages;
+
defaultText = literalMD ''
+
these packages, with their `meta.priority` numerically increased
(thus lowering their installation priority):
+
+
${defaultPackagesText}
'';
example = [];
description = lib.mdDoc ''
+2 -2
nixos/modules/misc/locate.nix
···
pruneNames = mkOption {
type = listOf str;
default = lib.optionals (!isFindutils) [ ".bzr" ".cache" ".git" ".hg" ".svn" ];
-
defaultText = literalDocBook ''
-
<literal>[ ".bzr" ".cache" ".git" ".hg" ".svn" ]</literal>, if
supported by the locate implementation (i.e. mlocate or plocate).
'';
description = lib.mdDoc ''
···
pruneNames = mkOption {
type = listOf str;
default = lib.optionals (!isFindutils) [ ".bzr" ".cache" ".git" ".hg" ".svn" ];
+
defaultText = literalMD ''
+
`[ ".bzr" ".cache" ".git" ".hg" ".svn" ]`, if
supported by the locate implementation (i.e. mlocate or plocate).
'';
description = lib.mdDoc ''
+1 -1
nixos/modules/programs/gnupg.nix
···
type = types.nullOr (types.enum pkgs.pinentry.flavors);
example = "gnome3";
default = defaultPinentryFlavor;
-
defaultText = literalDocBook ''matching the configured desktop environment'';
description = lib.mdDoc ''
Which pinentry interface to use. If not null, the path to the
pinentry binary will be passed to gpg-agent via commandline and
···
type = types.nullOr (types.enum pkgs.pinentry.flavors);
example = "gnome3";
default = defaultPinentryFlavor;
+
defaultText = literalMD ''matching the configured desktop environment'';
description = lib.mdDoc ''
Which pinentry interface to use. If not null, the path to the
pinentry binary will be passed to gpg-agent via commandline and
+2 -2
nixos/modules/services/audio/mpdscribble.nix
···
mpdCfg.credentials).passwordFile
else
null;
-
defaultText = literalDocBook ''
The first password file with read access configured for MPD when using a local instance,
-
otherwise <literal>null</literal>.
'';
type = types.nullOr types.str;
description = lib.mdDoc ''
···
mpdCfg.credentials).passwordFile
else
null;
+
defaultText = literalMD ''
The first password file with read access configured for MPD when using a local instance,
+
otherwise `null`.
'';
type = types.nullOr types.str;
description = lib.mdDoc ''
+3 -3
nixos/modules/services/cluster/kubernetes/addons/dns.nix
···
take 3 (splitString "." config.services.kubernetes.apiserver.serviceClusterIpRange
))
) + ".254";
-
defaultText = literalDocBook ''
-
The <literal>x.y.z.254</literal> IP of
-
<literal>config.${options.services.kubernetes.apiserver.serviceClusterIpRange}</literal>.
'';
type = types.str;
};
···
take 3 (splitString "." config.services.kubernetes.apiserver.serviceClusterIpRange
))
) + ".254";
+
defaultText = literalMD ''
+
The `x.y.z.254` IP of
+
`config.${options.services.kubernetes.apiserver.serviceClusterIpRange}`.
'';
type = types.str;
};
+1 -1
nixos/modules/services/cluster/kubernetes/kubelet.nix
···
key = mkOption {
description = lib.mdDoc "Key of taint.";
default = name;
-
defaultText = literalDocBook "Name of this submodule.";
type = str;
};
value = mkOption {
···
key = mkOption {
description = lib.mdDoc "Key of taint.";
default = name;
+
defaultText = literalMD "Name of this submodule.";
type = str;
};
value = mkOption {
+2 -2
nixos/modules/services/computing/slurm/slurm.nix
···
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
···
type = types.path;
internal = true;
default = etcSlurm;
+
defaultText = literalMD ''
Directory created from generated config files and
+
`config.${opt.extraConfigPaths}`.
'';
description = ''
Path to directory with slurm config files. This option is set by default from the
+1 -1
nixos/modules/services/continuous-integration/buildbot/master.nix
···
type = types.path;
description = lib.mdDoc "Optionally pass master.cfg path. Other options in this configuration will be ignored.";
default = defaultMasterCfg;
-
defaultText = literalDocBook ''generated configuration file'';
example = "/etc/nixos/buildbot/master.cfg";
};
···
type = types.path;
description = lib.mdDoc "Optionally pass master.cfg path. Other options in this configuration will be ignored.";
default = defaultMasterCfg;
+
defaultText = literalMD ''generated configuration file'';
example = "/etc/nixos/buildbot/master.cfg";
};
+1 -1
nixos/modules/services/continuous-integration/buildkite-agents.nix
···
hooksPath = mkOption {
type = types.path;
default = hooksDir config;
-
defaultText = literalDocBook "generated from <option>services.buildkite-agents.&lt;name&gt;.hooks</option>";
description = lib.mdDoc ''
Path to the directory storing the hooks.
Consider using {option}`services.buildkite-agents.<name>.hooks.<name>`
···
hooksPath = mkOption {
type = types.path;
default = hooksDir config;
+
defaultText = literalMD "generated from {option}`services.buildkite-agents.<name>.hooks`";
description = lib.mdDoc ''
Path to the directory storing the hooks.
Consider using {option}`services.buildkite-agents.<name>.hooks.<name>`
+2 -2
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
···
let
inherit (lib)
filterAttrs
-
literalDocBook
literalExpression
mkIf
mkOption
···
tomlFile = mkOption {
type = types.path;
internal = true;
-
defaultText = literalDocBook "generated <literal>hercules-ci-agent.toml</literal>";
description = ''
The fully assembled config file.
'';
···
let
inherit (lib)
filterAttrs
+
literalMD
literalExpression
mkIf
mkOption
···
tomlFile = mkOption {
type = types.path;
internal = true;
+
defaultText = literalMD "generated `hercules-ci-agent.toml`";
description = ''
The fully assembled config file.
'';
+1 -1
nixos/modules/services/games/quake3-server.nix
···
baseq3 = mkOption {
type = types.either types.package types.path;
default = defaultBaseq3;
-
defaultText = literalDocBook "Manually downloaded Quake 3 installation directory.";
example = "/var/lib/q3ds";
description = lib.mdDoc ''
Path to the baseq3 files (pak*.pk3). If this is on the nix store (type = package) all .pk3 files should be saved
···
baseq3 = mkOption {
type = types.either types.package types.path;
default = defaultBaseq3;
+
defaultText = literalMD "Manually downloaded Quake 3 installation directory.";
example = "/var/lib/q3ds";
description = lib.mdDoc ''
Path to the baseq3 files (pak*.pk3). If this is on the nix store (type = package) all .pk3 files should be saved
+1 -1
nixos/modules/services/misc/gitweb.nix
···
$highlight_bin = "${pkgs.highlight}/bin/highlight";
${cfg.extraConfig}
'';
-
defaultText = literalDocBook "generated config file";
type = types.path;
readOnly = true;
internal = true;
···
$highlight_bin = "${pkgs.highlight}/bin/highlight";
${cfg.extraConfig}
'';
+
defaultText = literalMD "generated config file";
type = types.path;
readOnly = true;
internal = true;
+1 -1
nixos/modules/services/misc/rippled.nix
···
config = mkOption {
internal = true;
default = pkgs.writeText "rippled.conf" rippledCfg;
-
defaultText = literalDocBook "generated config file";
};
};
};
···
config = mkOption {
internal = true;
default = pkgs.writeText "rippled.conf" rippledCfg;
+
defaultText = literalMD "generated config file";
};
};
};
+2 -2
nixos/modules/services/monitoring/thanos.nix
···
mkArgumentsOption = cmd: mkOption {
type = types.listOf types.str;
default = argumentsOf cmd;
-
defaultText = literalDocBook ''
-
calculated from <literal>config.services.thanos.${cmd}</literal>
'';
description = lib.mdDoc ''
Arguments to the `thanos ${cmd}` command.
···
mkArgumentsOption = cmd: mkOption {
type = types.listOf types.str;
default = argumentsOf cmd;
+
defaultText = literalMD ''
+
calculated from `config.services.thanos.${cmd}`
'';
description = lib.mdDoc ''
Arguments to the `thanos ${cmd}` command.
+1 -1
nixos/modules/services/networking/dnscrypt-proxy2.nix
···
''}
${pkgs.remarshal}/bin/json2toml < config.json > $out
'';
-
defaultText = literalDocBook "TOML file generated from <option>services.dnscrypt-proxy2.settings</option>";
};
};
···
''}
${pkgs.remarshal}/bin/json2toml < config.json > $out
'';
+
defaultText = literalMD "TOML file generated from {option}`services.dnscrypt-proxy2.settings`";
};
};
+1 -1
nixos/modules/services/networking/ferm.nix
···
config = mkOption {
description = lib.mdDoc "Verbatim ferm.conf configuration.";
default = "";
-
defaultText = literalDocBook "empty firewall, allows any traffic";
type = types.lines;
};
package = mkOption {
···
config = mkOption {
description = lib.mdDoc "Verbatim ferm.conf configuration.";
default = "";
+
defaultText = literalMD "empty firewall, allows any traffic";
type = types.lines;
};
package = mkOption {
+1 -1
nixos/modules/services/networking/firewall.nix
···
checkReversePath = mkOption {
type = types.either types.bool (types.enum ["strict" "loose"]);
default = kernelHasRPFilter;
-
defaultText = literalDocBook "<literal>true</literal> if supported by the chosen kernel";
example = "loose";
description =
lib.mdDoc ''
···
checkReversePath = mkOption {
type = types.either types.bool (types.enum ["strict" "loose"]);
default = kernelHasRPFilter;
+
defaultText = literalMD "`true` if supported by the chosen kernel";
example = "loose";
description =
lib.mdDoc ''
+1 -1
nixos/modules/services/networking/nftables.nix
···
name = "nftables-rules";
text = cfg.ruleset;
};
-
defaultText = literalDocBook ''a file with the contents of <option>networking.nftables.ruleset</option>'';
description =
lib.mdDoc ''
The ruleset file to be used with nftables. Should be in a format that
···
name = "nftables-rules";
text = cfg.ruleset;
};
+
defaultText = literalMD ''a file with the contents of {option}`networking.nftables.ruleset`'';
description =
lib.mdDoc ''
The ruleset file to be used with nftables. Should be in a format that
+1 -1
nixos/modules/services/networking/xrdp.nix
···
confDir = mkOption {
type = types.path;
default = confDir;
-
defaultText = literalDocBook "generated from configuration";
description = lib.mdDoc "The location of the config files for xrdp.";
};
};
···
confDir = mkOption {
type = types.path;
default = confDir;
+
defaultText = literalMD "generated from configuration";
description = lib.mdDoc "The location of the config files for xrdp.";
};
};
+3 -3
nixos/modules/services/web-apps/discourse.nix
···
enableACME = lib.mkOption {
type = lib.types.bool;
default = cfg.sslCertificate == null && cfg.sslCertificateKey == null;
-
defaultText = lib.literalDocBook ''
-
<literal>true</literal>, unless <option>services.discourse.sslCertificate</option>
-
and <option>services.discourse.sslCertificateKey</option> are set.
'';
description = lib.mdDoc ''
Whether an ACME certificate should be used to secure
···
enableACME = lib.mkOption {
type = lib.types.bool;
default = cfg.sslCertificate == null && cfg.sslCertificateKey == null;
+
defaultText = lib.literalMD ''
+
`true`, unless {option}`services.discourse.sslCertificate`
+
and {option}`services.discourse.sslCertificateKey` are set.
'';
description = lib.mdDoc ''
Whether an ACME certificate should be used to secure
+2 -2
nixos/modules/services/web-apps/keycloak.nix
···
mkDefault
literalExpression
isAttrs
-
literalDocBook
maintainers
catAttrs
collect
···
mkOption {
type = port;
default = dbPorts.${cfg.database.type};
-
defaultText = literalDocBook "default port of selected database";
description = lib.mdDoc ''
Port of the database to connect to.
'';
···
mkDefault
literalExpression
isAttrs
+
literalMD
maintainers
catAttrs
collect
···
mkOption {
type = port;
default = dbPorts.${cfg.database.type};
+
defaultText = literalMD "default port of selected database";
description = lib.mdDoc ''
Port of the database to connect to.
'';
+1 -1
nixos/modules/services/web-apps/nextcloud.nix
···
occ = mkOption {
type = types.package;
default = occ;
-
defaultText = literalDocBook "generated script";
internal = true;
description = ''
The nextcloud-occ program preconfigured to target this Nextcloud instance.
···
occ = mkOption {
type = types.package;
default = occ;
+
defaultText = literalMD "generated script";
internal = true;
description = ''
The nextcloud-occ program preconfigured to target this Nextcloud instance.
+2 -2
nixos/modules/services/web-servers/lighttpd/collectd.nix
···
collectionCgi = mkOption {
type = types.path;
default = defaultCollectionCgi;
-
defaultText = literalDocBook ''
-
<literal>config.${options.services.collectd.package}</literal> configured for lighttpd
'';
description = lib.mdDoc ''
Path to collection.cgi script from (collectd sources)/contrib/collection.cgi
···
collectionCgi = mkOption {
type = types.path;
default = defaultCollectionCgi;
+
defaultText = literalMD ''
+
`config.${options.services.collectd.package}` configured for lighttpd
'';
description = lib.mdDoc ''
Path to collection.cgi script from (collectd sources)/contrib/collection.cgi
+2 -2
nixos/modules/services/web-servers/trafficserver/default.nix
···
ipAllow = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./ip_allow.json;
-
defaultText = literalDocBook "upstream defaults";
example = literalExpression ''
{
ip_allow = [{
···
logging = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./logging.json;
-
defaultText = literalDocBook "upstream defaults";
example = { };
description = lib.mdDoc ''
Configure logs.
···
ipAllow = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./ip_allow.json;
+
defaultText = literalMD "upstream defaults";
example = literalExpression ''
{
ip_allow = [{
···
logging = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./logging.json;
+
defaultText = literalMD "upstream defaults";
example = { };
description = lib.mdDoc ''
Configure logs.
+1 -1
nixos/modules/services/x11/display-managers/default.nix
···
defaultSessionFromLegacyOptions
else
null;
-
defaultText = literalDocBook ''
Taken from display manager settings or window manager settings, if either is set.
'';
example = "gnome";
···
defaultSessionFromLegacyOptions
else
null;
+
defaultText = literalMD ''
Taken from display manager settings or window manager settings, if either is set.
'';
example = "gnome";
+1 -1
nixos/modules/system/activation/activation-script.nix
···
readOnly = true;
internal = true;
default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true;
-
defaultText = literalDocBook "generated activation script";
};
system.userActivationScripts = mkOption {
···
readOnly = true;
internal = true;
default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true;
+
defaultText = literalMD "generated activation script";
};
system.userActivationScripts = mkOption {
+3 -3
nixos/modules/system/boot/plymouth.nix
···
themePackages = mkOption {
default = lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;
-
defaultText = literalDocBook ''
A NixOS branded variant of the breeze theme when
-
<literal>config.${opt.theme} == "breeze"</literal>, otherwise
-
<literal>[ ]</literal>.
'';
type = types.listOf types.package;
description = lib.mdDoc ''
···
themePackages = mkOption {
default = lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;
+
defaultText = literalMD ''
A NixOS branded variant of the breeze theme when
+
`config.${opt.theme} == "breeze"`, otherwise
+
`[ ]`.
'';
type = types.listOf types.package;
description = lib.mdDoc ''
+1 -1
nixos/modules/system/boot/stage-1.nix
···
then "zstd"
else "gzip"
);
-
defaultText = literalDocBook "<literal>zstd</literal> if the kernel supports it (5.9+), <literal>gzip</literal> if not";
type = types.either types.str (types.functionTo types.str);
description = ''
The compressor to use on the initrd image. May be any of:
···
then "zstd"
else "gzip"
);
+
defaultText = literalMD "`zstd` if the kernel supports it (5.9+), `gzip` if not";
type = types.either types.str (types.functionTo types.str);
description = ''
The compressor to use on the initrd image. May be any of:
+1 -1
nixos/modules/tasks/filesystems/zfs.nix
···
readOnly = true;
type = types.bool;
default = inInitrd || inSystem;
-
defaultText = literalDocBook "<literal>true</literal> if ZFS filesystem support is enabled";
description = lib.mdDoc "True if ZFS filesystem support is enabled";
};
···
readOnly = true;
type = types.bool;
default = inInitrd || inSystem;
+
defaultText = literalMD "`true` if ZFS filesystem support is enabled";
description = lib.mdDoc "True if ZFS filesystem support is enabled";
};
+1 -1
nixos/modules/virtualisation/digital-ocean-init.nix
···
options.virtualisation.digitalOcean.defaultConfigFile = mkOption {
type = types.path;
default = defaultConfigFile;
-
defaultText = literalDocBook ''
The default configuration imports user-data if applicable and
`(modulesPath + "/virtualisation/digital-ocean-config.nix")`.
'';
···
options.virtualisation.digitalOcean.defaultConfigFile = mkOption {
type = types.path;
default = defaultConfigFile;
+
defaultText = literalMD ''
The default configuration imports user-data if applicable and
`(modulesPath + "/virtualisation/digital-ocean-config.nix")`.
'';