colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/*: literalDocBook -> literalMD

Browse Source 
no change to rendered output
This commit is contained in:
pennae 2022-08-20 22:27:20 +02:00 committed by pennae
parent 169072fb60
commit 51a11254a7
31 changed files with 48 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/modules/config/networking.nix
View File

@ -35,7 +35,7 @@ in
networking.hostFiles = lib.mkOption {
type = types.listOf types.path;
defaultText = literalDocBook "Hosts from <option>networking.hosts</option> and <option>networking.extraHosts</option>";
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`.

7
nixos/modules/config/system-path.nix
View File

@ -78,10 +78,11 @@ in
defaultPackages = mkOption {
type = types.listOf types.package;
default = defaultPackages;
defaultText = literalDocBook ''
these packages, with their <literal>meta.priority</literal> numerically increased
defaultText = literalMD ''
these packages, with their `meta.priority` numerically increased
(thus lowering their installation priority):
<programlisting>${defaultPackagesText}</programlisting>
${defaultPackagesText}
'';
example = [];
description = lib.mdDoc ''

4
nixos/modules/misc/locate.nix
View File

@ -183,8 +183,8 @@ in
pruneNames = mkOption {
type = listOf str;
default = lib.optionals (!isFindutils) [ ".bzr" ".cache" ".git" ".hg" ".svn" ];
defaultText = literalDocBook ''
<literal>[ ".bzr" ".cache" ".git" ".hg" ".svn" ]</literal>, if
defaultText = literalMD ''
`[ ".bzr" ".cache" ".git" ".hg" ".svn" ]`, if
supported by the locate implementation (i.e. mlocate or plocate).
'';
description = lib.mdDoc ''

2
nixos/modules/programs/gnupg.nix
View File

@ -71,7 +71,7 @@ in
type = types.nullOr (types.enum pkgs.pinentry.flavors);
example = "gnome3";
default = defaultPinentryFlavor;
defaultText = literalDocBook ''matching the configured desktop environment'';
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

4
nixos/modules/services/audio/mpdscribble.nix
View File

@ -128,9 +128,9 @@ in {
mpdCfg.credentials).passwordFile
else
null;
defaultText = literalDocBook ''
defaultText = literalMD ''
The first password file with read access configured for MPD when using a local instance,
otherwise <literal>null</literal>.
otherwise `null`.
'';
type = types.nullOr types.str;
description = lib.mdDoc ''

6
nixos/modules/services/cluster/kubernetes/addons/dns.nix
View File

@ -23,9 +23,9 @@ in {
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>.
defaultText = literalMD ''
The `x.y.z.254` IP of
`config.${options.services.kubernetes.apiserver.serviceClusterIpRange}`.
'';
type = types.str;
};

2
nixos/modules/services/cluster/kubernetes/kubelet.nix
View File

@ -40,7 +40,7 @@ let
key = mkOption {
description = lib.mdDoc "Key of taint.";
default = name;
defaultText = literalDocBook "Name of this submodule.";
defaultText = literalMD "Name of this submodule.";
type = str;
};
value = mkOption {

4
nixos/modules/services/computing/slurm/slurm.nix
View File

@ -281,9 +281,9 @@ in
type = types.path;
internal = true;
default = etcSlurm;
defaultText = literalDocBook ''
defaultText = literalMD ''
Directory created from generated config files and
<literal>config.${opt.extraConfigPaths}</literal>.
`config.${opt.extraConfigPaths}`.
'';
description = ''
Path to directory with slurm config files. This option is set by default from the

2
nixos/modules/services/continuous-integration/buildbot/master.nix
View File

@ -94,7 +94,7 @@ in {
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'';
defaultText = literalMD ''generated configuration file'';
example = "/etc/nixos/buildbot/master.cfg";
};

2
nixos/modules/services/continuous-integration/buildkite-agents.nix
View File

@ -168,7 +168,7 @@ let
hooksPath = mkOption {
type = types.path;
default = hooksDir config;
defaultText = literalDocBook "generated from <option>services.buildkite-agents.&lt;name&gt;.hooks</option>";
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>`

4
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
View File

@ -10,7 +10,7 @@
let
inherit (lib)
filterAttrs
literalDocBook
literalMD
literalExpression
mkIf
mkOption
@ -235,7 +235,7 @@ in
tomlFile = mkOption {
type = types.path;
internal = true;
defaultText = literalDocBook "generated <literal>hercules-ci-agent.toml</literal>";
defaultText = literalMD "generated `hercules-ci-agent.toml`";
description = ''
The fully assembled config file.
'';

2
nixos/modules/services/games/quake3-server.nix
View File

@ -71,7 +71,7 @@ in {
baseq3 = mkOption {
type = types.either types.package types.path;
default = defaultBaseq3;
defaultText = literalDocBook "Manually downloaded Quake 3 installation directory.";
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

2
nixos/modules/services/misc/gitweb.nix
View File

@ -47,7 +47,7 @@ in
$highlight_bin = "${pkgs.highlight}/bin/highlight";
${cfg.extraConfig}
'';
defaultText = literalDocBook "generated config file";
defaultText = literalMD "generated config file";
type = types.path;
readOnly = true;
internal = true;

2
nixos/modules/services/misc/rippled.nix
View File

@ -401,7 +401,7 @@ in
config = mkOption {
internal = true;
default = pkgs.writeText "rippled.conf" rippledCfg;
defaultText = literalDocBook "generated config file";
defaultText = literalMD "generated config file";
};
};
};

4
nixos/modules/services/monitoring/thanos.nix
View File

@ -83,8 +83,8 @@ let
mkArgumentsOption = cmd: mkOption {
type = types.listOf types.str;
default = argumentsOf cmd;
defaultText = literalDocBook ''
calculated from <literal>config.services.thanos.${cmd}</literal>
defaultText = literalMD ''
calculated from `config.services.thanos.${cmd}`
'';
description = lib.mdDoc ''
Arguments to the `thanos ${cmd}` command.

2
nixos/modules/services/networking/dnscrypt-proxy2.nix
View File

@ -56,7 +56,7 @@ in
''}
${pkgs.remarshal}/bin/json2toml < config.json > $out
'';
defaultText = literalDocBook "TOML file generated from <option>services.dnscrypt-proxy2.settings</option>";
defaultText = literalMD "TOML file generated from {option}`services.dnscrypt-proxy2.settings`";
};
};

2
nixos/modules/services/networking/ferm.nix
View File

@ -30,7 +30,7 @@ in {
config = mkOption {
description = lib.mdDoc "Verbatim ferm.conf configuration.";
default = "";
defaultText = literalDocBook "empty firewall, allows any traffic";
defaultText = literalMD "empty firewall, allows any traffic";
type = types.lines;
};
package = mkOption {

2
nixos/modules/services/networking/firewall.nix
View File

@ -417,7 +417,7 @@ in
checkReversePath = mkOption {
type = types.either types.bool (types.enum ["strict" "loose"]);
default = kernelHasRPFilter;
defaultText = literalDocBook "<literal>true</literal> if supported by the chosen kernel";
defaultText = literalMD "`true` if supported by the chosen kernel";
example = "loose";
description =
lib.mdDoc ''

2
nixos/modules/services/networking/nftables.nix
View File

@ -88,7 +88,7 @@ in
name = "nftables-rules";
text = cfg.ruleset;
};
defaultText = literalDocBook ''a file with the contents of <option>networking.nftables.ruleset</option>'';
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

2
nixos/modules/services/networking/xrdp.nix
View File

@ -100,7 +100,7 @@ in
confDir = mkOption {
type = types.path;
default = confDir;
defaultText = literalDocBook "generated from configuration";
defaultText = literalMD "generated from configuration";
description = lib.mdDoc "The location of the config files for xrdp.";
};
};

6
nixos/modules/services/web-apps/discourse.nix
View File

@ -100,9 +100,9 @@ in
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.
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

4
nixos/modules/services/web-apps/keycloak.nix
View File

@ -20,7 +20,7 @@ let
mkDefault
literalExpression
isAttrs
literalDocBook
literalMD
maintainers
catAttrs
collect
@ -165,7 +165,7 @@ in
mkOption {
type = port;
default = dbPorts.${cfg.database.type};
defaultText = literalDocBook "default port of selected database";
defaultText = literalMD "default port of selected database";
description = lib.mdDoc ''
Port of the database to connect to.
'';

2
nixos/modules/services/web-apps/nextcloud.nix
View File

@ -527,7 +527,7 @@ in {
occ = mkOption {
type = types.package;
default = occ;
defaultText = literalDocBook "generated script";
defaultText = literalMD "generated script";
internal = true;
description = ''
The nextcloud-occ program preconfigured to target this Nextcloud instance.

4
nixos/modules/services/web-servers/lighttpd/collectd.nix
View File

@ -30,8 +30,8 @@ in
collectionCgi = mkOption {
type = types.path;
default = defaultCollectionCgi;
defaultText = literalDocBook ''
<literal>config.${options.services.collectd.package}</literal> configured for lighttpd
defaultText = literalMD ''
`config.${options.services.collectd.package}` configured for lighttpd
'';
description = lib.mdDoc ''
Path to collection.cgi script from (collectd sources)/contrib/collection.cgi

4
nixos/modules/services/web-servers/trafficserver/default.nix
View File

@ -62,7 +62,7 @@ in
ipAllow = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./ip_allow.json;
defaultText = literalDocBook "upstream defaults";
defaultText = literalMD "upstream defaults";
example = literalExpression ''
{
ip_allow = [{
@ -85,7 +85,7 @@ in
logging = mkOption {
type = types.nullOr yaml.type;
default = lib.importJSON ./logging.json;
defaultText = literalDocBook "upstream defaults";
defaultText = literalMD "upstream defaults";
example = { };
description = lib.mdDoc ''
Configure logs.

2
nixos/modules/services/x11/display-managers/default.nix
View File

@ -285,7 +285,7 @@ in
defaultSessionFromLegacyOptions
else
null;
defaultText = literalDocBook ''
defaultText = literalMD ''
Taken from display manager settings or window manager settings, if either is set.
'';
example = "gnome";

2
nixos/modules/system/activation/activation-script.nix
View File

@ -143,7 +143,7 @@ in
readOnly = true;
internal = true;
default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true;
defaultText = literalDocBook "generated activation script";
defaultText = literalMD "generated activation script";
};
system.userActivationScripts = mkOption {

6
nixos/modules/system/boot/plymouth.nix
View File

@ -75,10 +75,10 @@ in
themePackages = mkOption {
default = lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;
defaultText = literalDocBook ''
defaultText = literalMD ''
A NixOS branded variant of the breeze theme when
<literal>config.${opt.theme} == "breeze"</literal>, otherwise
<literal>[ ]</literal>.
`config.${opt.theme} == "breeze"`, otherwise
`[ ]`.
'';
type = types.listOf types.package;
description = lib.mdDoc ''

2
nixos/modules/system/boot/stage-1.nix
View File

@ -611,7 +611,7 @@ in
then "zstd"
else "gzip"
);
defaultText = literalDocBook "<literal>zstd</literal> if the kernel supports it (5.9+), <literal>gzip</literal> if not";
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:

2
nixos/modules/tasks/filesystems/zfs.nix
View File

@ -209,7 +209,7 @@ in
readOnly = true;
type = types.bool;
default = inInitrd || inSystem;
defaultText = literalDocBook "<literal>true</literal> if ZFS filesystem support is enabled";
defaultText = literalMD "`true` if ZFS filesystem support is enabled";
description = lib.mdDoc "True if ZFS filesystem support is enabled";
};

2
nixos/modules/virtualisation/digital-ocean-init.nix
View File

@ -20,7 +20,7 @@ in {
options.virtualisation.digitalOcean.defaultConfigFile = mkOption {
type = types.path;
default = defaultConfigFile;
defaultText = literalDocBook ''
defaultText = literalMD ''
The default configuration imports user-data if applicable and
`(modulesPath + "/virtualisation/digital-ocean-config.nix")`.
'';