NixOS/nixpkgs
1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 17:46:29 +09:00
Code Activity

nixos/*: mark pre-existing markdown descriptions as mdDoc

Browse source
This commit is contained in:
pennae 2022-08-14 09:03:30 +02:00 • committed by pennae
parent b51f8036c2
commit 7e7d68a250
70 changed files with 96 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

2
nixos/modules/hardware/corectrl.nix
View file

@ -20,7 +20,7 @@ in
type = types.str;
default = "0xfffd7fff";
example = "0xffffffff";
description = ''
description = lib.mdDoc ''
Sets the `amdgpu.ppfeaturemask` kernel option.
In particular, it is used here to set the overdrive bit.
Default is `0xfffd7fff` as it is less likely to cause flicker issues.

2
nixos/modules/misc/wordlist.nix
View file

@ -23,7 +23,7 @@ in
}
'';
description = ''
description = lib.mdDoc ''
A set with the key names being the environment variable you'd like to
set and the values being a list of paths to text documents containing
lists of words. The various files will be merged, sorted, duplicates

2
nixos/modules/programs/mosh.nix
View file

@ -17,7 +17,7 @@ in
type = lib.types.bool;
};
withUtempter = mkOption {
description = ''
description = lib.mdDoc ''
Whether to enable libutempter for mosh.
This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).
Note, this will add a guid wrapper for the group utmp!

2
nixos/modules/programs/msmtp.nix
View file

@ -45,7 +45,7 @@ in {
passwordeval = "cat /secrets/password.txt";
};
};
description = ''
description = lib.mdDoc ''
Named accounts and their respective configurations.
The special name "default" allows a default account to be defined.
See msmtp(1) for the available options.

2
nixos/modules/programs/thefuck.nix
View file

@ -22,7 +22,7 @@ in
default = "fuck";
type = types.str;
description = ''
description = lib.mdDoc ''
`thefuck` needs an alias to be configured.
The default value is `fuck`, but you can use anything else as well.
'';

2
nixos/modules/programs/yabar.nix
View file

@ -62,7 +62,7 @@ in
to use `yabar-unstable'.
'';
description = ''
description = lib.mdDoc ''
The package which contains the `yabar` binary.
Nixpkgs provides the `yabar` and `yabar-unstable`

8
nixos/modules/programs/zsh/oh-my-zsh.nix
View file

@ -49,7 +49,7 @@ in
package = mkOption {
default = pkgs.oh-my-zsh;
defaultText = literalExpression "pkgs.oh-my-zsh";
description = ''
description = lib.mdDoc ''
Package to install for `oh-my-zsh` usage.
'';
@ -67,7 +67,7 @@ in
custom = mkOption {
default = null;
type = with types; nullOr str;
description = ''
description = lib.mdDoc ''
Path to a custom oh-my-zsh package to override config of oh-my-zsh.
(Can't be used along with `customPkgs`).
'';
@ -76,7 +76,7 @@ in
customPkgs = mkOption {
default = [];
type = types.listOf types.package;
description = ''
description = lib.mdDoc ''
List of custom packages that should be loaded into `oh-my-zsh`.
'';
};
@ -92,7 +92,7 @@ in
cacheDir = mkOption {
default = "$HOME/.cache/oh-my-zsh";
type = types.str;
description = ''
description = lib.mdDoc ''
Cache directory to be used by `oh-my-zsh`.
Without this option it would default to the read-only nix store.
'';

2
nixos/modules/programs/zsh/zsh-autoenv.nix
View file

@ -11,7 +11,7 @@ in {
package = mkOption {
default = pkgs.zsh-autoenv;
defaultText = literalExpression "pkgs.zsh-autoenv";
description = ''
description = lib.mdDoc ''
Package to install for `zsh-autoenv` usage.
'';

2
nixos/modules/programs/zsh/zsh-autosuggestions.nix
View file

@ -24,7 +24,7 @@ in
strategy = mkOption {
type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
default = [ "history" ];
description = ''
description = lib.mdDoc ''
`ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.
The strategies in the array are tried successively until a suggestion is found.
There are currently three built-in strategies to choose from:

2
nixos/modules/security/acme/default.nix
View file

@ -676,7 +676,7 @@ let
inheritDefaults = mkOption {
default = true;
example = true;
description = "Whether to inherit values set in `security.acme.defaults` or not.";
description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not.";
type = lib.types.bool;
};
};

2
nixos/modules/security/sudo.nix
View file

@ -46,7 +46,7 @@ in
type = types.package;
default = pkgs.sudo;
defaultText = literalExpression "pkgs.sudo";
description = ''
description = lib.mdDoc ''
Which package to use for `sudo`.
'';
};

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

@ -193,7 +193,7 @@ in
options.services.buildkite-agents = mkOption {
type = types.attrsOf (types.submodule buildkiteOptions);
default = {};
description = ''
description = lib.mdDoc ''
Attribute set of buildkite agents.
The attribute key is combined with the hostname and a unique integer to
create the final agent name. This can be overridden by setting the `name`

2
nixos/modules/services/continuous-integration/hydra/default.nix
View file

@ -87,7 +87,7 @@ in
type = types.str;
default = localDB;
example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";
description = ''
description = lib.mdDoc ''
The DBI string for Hydra database connection.
NOTE: Attempts to set `application_name` will be overridden by

2
nixos/modules/services/development/lorri.nix
View file

@ -9,7 +9,7 @@ in {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
description = lib.mdDoc ''
Enables the daemon for `lorri`, a nix-shell replacement for project
development. The socket-activated daemon starts on the first request
issued by the `lorri` command.

2
nixos/modules/services/editors/infinoted.nix
View file

@ -36,7 +36,7 @@ in {
certificateChain = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Chain of CA-certificates to which our `certificateFile` is relative.
Optional for TLS.
'';

4
nixos/modules/services/games/crossfire-server.nix
View file

@ -41,7 +41,7 @@ in {
stateDir = mkOption {
type = types.str;
default = "/var/lib/crossfire";
description = ''
description = lib.mdDoc ''
Where to store runtime data (save files, persistent items, etc).
If left at the default, this will be automatically created on server
@ -61,7 +61,7 @@ in {
configFiles = mkOption {
type = types.attrsOf types.str;
description = ''
description = lib.mdDoc ''
Text to append to the corresponding configuration files. Note that the
files given in the example are *not* the complete set of files available
to customize; look in /etc/crossfire after enabling the server to see

2
nixos/modules/services/games/deliantra-server.nix
View file

@ -41,7 +41,7 @@ in {
stateDir = mkOption {
type = types.str;
default = "/var/lib/deliantra";
description = ''
description = lib.mdDoc ''
Where to store runtime data (save files, persistent items, etc).
If left at the default, this will be automatically created on server

6
nixos/modules/services/games/minetest-server.nix
View file

@ -25,7 +25,7 @@ in
gameId = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Id of the game to use. To list available games run
`minetestserver --gameid list`.
@ -36,7 +36,7 @@ in
world = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Name of the world to use. To list available worlds run
`minetestserver --world list`.
@ -47,7 +47,7 @@ in
configPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to the config to use.
If set to null, the config of the running user will be used:

4
nixos/modules/services/logging/logrotate.nix
View file

@ -79,7 +79,7 @@ let
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
Order of this logrotate block in relation to the others. The semantics are
the same as with `lib.mkOrder`. Smaller values have a greater priority.
'';
@ -260,7 +260,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
Order of this logrotate block in relation to the others. The semantics are
the same as with `lib.mkOrder`. Smaller values are inserted first.
'';

2
nixos/modules/services/matrix/synapse.nix
View file

@ -516,7 +516,7 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
Is the preview URL API enabled? If enabled, you *must* specify an
explicit url_preview_ip_range_blacklist of IPs that the spider is
denied from accessing.

2
nixos/modules/services/misc/gitea.nix
View file

@ -183,7 +183,7 @@ in
file = mkOption {
type = types.nullOr types.str;
default = null;
description = "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
example = "gitea-dump";
};
};

2
nixos/modules/services/misc/klipper.nix
View file

@ -82,7 +82,7 @@ in
'';
configFile = mkOption {
type = path;
description = "Path to firmware config which is generated using `klipper-genconf`";
description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";
};
};
});

2
nixos/modules/services/misc/nix-daemon.nix
View file

@ -264,7 +264,7 @@ in
type = types.nullOr types.str;
default = null;
example = "/root/.ssh/id_buildhost_builduser";
description = ''
description = lib.mdDoc ''
The path to the SSH private key with which to authenticate on
the build machine. The private key must not have a passphrase.
If null, the building user (root on NixOS machines) must have an

2
nixos/modules/services/misc/rmfakecloud.nix
View file

@ -50,7 +50,7 @@ in {
type = with types; attrsOf str;
default = { };
example = { DATADIR = "/custom/path/for/rmfakecloud/data"; };
description = ''
description = lib.mdDoc ''
Extra settings in the form of a set of key-value pairs.
For tokens and secrets, use `environmentFile` instead.

2
nixos/modules/services/misc/zoneminder.nix
View file

@ -80,7 +80,7 @@ in {
webserver = mkOption {
type = types.enum [ "nginx" "none" ];
default = "nginx";
description = ''
description = lib.mdDoc ''
The webserver to configure for the PHP frontend.
Set it to `none` if you want to configure it yourself. PRs are welcome

2
nixos/modules/services/monitoring/collectd.nix
View file

@ -52,7 +52,7 @@ in {
buildMinimalPackage = mkOption {
default = false;
description = ''
description = lib.mdDoc ''
Build a minimal collectd package with only the configured `services.collectd.plugins`
'';
type = bool;

4
nixos/modules/services/monitoring/datadog-agent.nix
View file

@ -60,7 +60,7 @@ in {
package = mkOption {
default = pkgs.datadog-agent;
defaultText = literalExpression "pkgs.datadog-agent";
description = ''
description = lib.mdDoc ''
Which DataDog v7 agent package to use. Note that the provided
package is expected to have an overridable `pythonPackages`-attribute
which configures the Python environment with the Datadog
@ -168,7 +168,7 @@ in {
};
checks = mkOption {
description = ''
description = lib.mdDoc ''
Configuration for all Datadog checks. Keys of this attribute
set will be used as the name of the check to create the
appropriate configuration in `conf.d/$check.d/conf.yaml`.

6
nixos/modules/services/monitoring/prometheus/default.nix
View file

@ -251,7 +251,7 @@ let
authorization = mkOption {
type = types.nullOr types.attrs;
default = null;
description = ''
description = lib.mdDoc ''
Sets the `Authorization` header on every scrape request with the configured credentials.
'';
};
@ -664,7 +664,7 @@ let
promTypes.dockerswarm_sd_config = mkDockerSdConfigModule {
role = mkOption {
type = types.enum [ "services" "tasks" "nodes" ];
description = ''
description = lib.mdDoc ''
Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
'';
};
@ -1222,7 +1222,7 @@ let
role = mkOption {
type = types.enum [ "instance" "baremetal" ];
description = ''
description = lib.mdDoc ''
Role of the targets to retrieve. Must be `instance` or `baremetal`.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
View file

@ -10,7 +10,7 @@ in {
settings = mkOption {
type = types.attrs;
default = {};
description = ''
description = lib.mdDoc ''
All settings of nginxlog expressed as an Nix attrset.
Check the official documentation for the corresponding YAML

2
nixos/modules/services/monitoring/riemann-tools.nix
View file

@ -37,7 +37,7 @@ in {
extraArgs = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
A list of commandline-switches forwarded to a riemann-tool.
See for example `riemann-health --help` for available options.
'';

6
nixos/modules/services/network-filesystems/xtreemfs.nix
View file

@ -111,7 +111,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.
@ -236,7 +236,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.
@ -379,7 +379,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.

2
nixos/modules/services/networking/bind.nix
View file

@ -117,7 +117,7 @@ in
cacheNetworks = mkOption {
default = [ "127.0.0.0/24" ];
type = types.listOf types.str;
description = ''
description = lib.mdDoc ''
What networks are allowed to use us as a resolver. Note
that this is for recursive queries -- all networks are
allowed to query zones configured with the `zones` option.

2
nixos/modules/services/networking/cloudflare-dyndns.nix
View file

@ -13,7 +13,7 @@ in
apiTokenFile = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
The path to a file containing the CloudFlare API token.
The file must have the form `CLOUDFLARE_API_TOKEN=...`

2
nixos/modules/services/networking/dhcpcd.nix
View file

@ -155,7 +155,7 @@ in
type = types.lines;
default = "";
example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi";
description = ''
description = lib.mdDoc ''
Shell code that will be run after all other hooks. See
`man dhcpcd-run-hooks` for details on what is possible.
'';

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

@ -20,7 +20,7 @@ in {
enable = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Ferm Firewall.
*Warning*: Enabling this service WILL disable the existing NixOS
firewall! Default firewall rules provided by packages are not

2
nixos/modules/services/networking/fireqos.nix
View file

@ -10,7 +10,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If enabled, FireQOS will be launched with the specified
configuration given in `config`.
'';

2
nixos/modules/services/networking/gnunet.nix
View file

@ -123,7 +123,7 @@ in
extraOptions = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional options that will be copied verbatim in `gnunet.conf'.
See `gnunet.conf(5)' for details.
'';

2
nixos/modules/services/networking/headscale.nix
View file

@ -216,7 +216,7 @@ in
magicDns = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
Only works if there is at least a nameserver defined.
'';

2
nixos/modules/services/networking/iscsi/root-initiator.nix
View file

@ -77,7 +77,7 @@ in
};
extraConfigFile = mkOption {
description = ''
description = lib.mdDoc ''
Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path
and store passwords in this file. Note: the file specified here must be available
in the initrd, see: `boot.initrd.secrets`.

2
nixos/modules/services/networking/lokinet.nix
View file

@ -95,7 +95,7 @@ in with lib; {
network.exit-node = [ "example.loki" "example2.loki" ];
}
'';
description = ''
description = lib.mdDoc ''
Configuration for Lokinet.
Currently, the best way to view the available settings is by
generating a config file using `lokinet -g`.

2
nixos/modules/services/networking/monero.nix
View file

@ -181,7 +181,7 @@ in
exclusiveNodes = mkOption {
type = types.listOf types.str;
default = [ ];
description = ''
description = lib.mdDoc ''
List of peer IP addresses to connect to *only*.
If given the other peer options will be ignored.
'';

2
nixos/modules/services/networking/murmur.nix
View file

@ -219,7 +219,7 @@ in
registerHostname = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
DNS hostname where your server can be reached. This is only
needed if you want your server to be accessed by its
hostname and not IP - but the name *must* resolve on the

2
nixos/modules/services/networking/nar-serve.nix
View file

@ -23,7 +23,7 @@ in
cacheURL = mkOption {
type = types.str;
default = "https://cache.nixos.org/";
description = ''
description = lib.mdDoc ''
Binary cache URL to connect to.
The URL format is compatible with the nix remote url style, such as:

2
nixos/modules/services/networking/nixops-dns.nix
View file

@ -40,7 +40,7 @@ in
dnsmasq = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Enable dnsmasq forwarding to nixops-dns. This allows to use
nixops-dns for `services.nixops-dns.domain` resolution
while forwarding the rest of the queries to original resolvers.

2
nixos/modules/services/networking/ocserv.nix
View file

@ -15,7 +15,7 @@ in
config = mkOption {
type = types.lines;
description = ''
description = lib.mdDoc ''
Configuration content to start an OCServ server.
For a full configuration reference,please refer to the online documentation

4
nixos/modules/services/networking/redsocks.nix
View file

@ -30,7 +30,7 @@ in
type = types.str;
default = "stderr";
description =
''
lib.mdDoc ''
Where to send logs.
Possible values are:
@ -122,7 +122,7 @@ in
"Forwarded_ipport" ];
default = "false";
description =
''
lib.mdDoc ''
Way to disclose client IP to the proxy.
- "false": do not disclose
http-connect supports the following ways:

2
nixos/modules/services/networking/rpcbind.nix
View file

@ -13,7 +13,7 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable `rpcbind', an ONC RPC directory service
notably used by NFS and NIS, and which can be queried
using the rpcinfo(1) command. `rpcbind` is a replacement for

2
nixos/modules/services/networking/x2goserver.nix
View file

@ -50,7 +50,7 @@ in {
settings = mkOption {
type = types.attrsOf types.attrs;
default = {};
description = ''
description = lib.mdDoc ''
x2goserver.conf ini configuration as nix attributes. See
`x2goserver.conf(5)` for details
'';

6
nixos/modules/services/networking/znc/options.nix
View file

@ -118,7 +118,7 @@ in
type = types.listOf types.str;
default = [ "webadmin" "adminlog" ];
example = [ "partyline" "webadmin" "adminlog" "log" ];
description = ''
description = lib.mdDoc ''
A list of modules to include in the `znc.conf` file.
'';
};
@ -127,7 +127,7 @@ in
type = types.listOf types.str;
default = [ "chansaver" "controlpanel" ];
example = [ "chansaver" "controlpanel" "fish" "push" ];
description = ''
description = lib.mdDoc ''
A list of user modules to include in the `znc.conf` file.
'';
};
@ -216,7 +216,7 @@ in
extraZncConf = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra config to `znc.conf` file.
'';
};

2
nixos/modules/services/search/meilisearch.nix
View file

@ -68,7 +68,7 @@ in
};
logLevel = mkOption {
description = ''
description = lib.mdDoc ''
Defines how much detail should be present in MeiliSearch's logs.
MeiliSearch currently supports four log levels, listed in order of increasing verbosity:
- 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected

2
nixos/modules/services/security/fail2ban.nix
View file

@ -73,7 +73,7 @@ in
default = [];
type = types.listOf types.package;
example = lib.literalExpression "[ pkgs.ipset ]";
description = ''
description = lib.mdDoc ''
Extra packages to be made available to the fail2ban service. The example contains
the packages needed by the `iptables-ipset-proto6` action.
'';

2
nixos/modules/services/security/infnoise.nix
View file

@ -10,7 +10,7 @@ in {
enable = mkEnableOption "the Infinite Noise TRNG driver";
fillDevRandom = mkOption {
description = ''
description = lib.mdDoc ''
Whether to run the infnoise driver as a daemon to refill /dev/random.
If disabled, you can use the `infnoise` command-line tool to

2
nixos/modules/services/security/oauth2_proxy.nix
View file

@ -347,7 +347,7 @@ in
domain = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Optional cookie domains to force cookies to (ie: `.yourcompany.com`).
The longest domain matching the request's host will be used (or the shortest
cookie domain if there is no match).

4
nixos/modules/services/system/cloud-init.nix
View file

@ -39,7 +39,7 @@ in
btrfs.enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Allow the cloud-init service to operate `btrfs` filesystem.
'';
};
@ -47,7 +47,7 @@ in
ext4.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Allow the cloud-init service to operate `ext4` filesystem.
'';
};

12
nixos/modules/services/system/self-deploy.nix
View file

@ -41,7 +41,7 @@ in
default = null;
description = ''
description = lib.mdDoc ''
Attribute of `nixFile` that builds the current system.
'';
};
@ -51,7 +51,7 @@ in
default = { };
description = ''
description = lib.mdDoc ''
Arguments to `nix-build` passed as `--argstr` or `--arg` depending on
the type.
'';
@ -62,7 +62,7 @@ in
default = "switch";
description = ''
description = lib.mdDoc ''
The `switch-to-configuration` subcommand used.
'';
};
@ -70,7 +70,7 @@ in
repository = lib.mkOption {
type = with lib.types; oneOf [ path str ];
description = ''
description = lib.mdDoc ''
The repository to fetch from. Must be properly formatted for git.
If this value is set to a path (must begin with `/`) then it's
@ -99,7 +99,7 @@ in
default = "master";
description = ''
description = lib.mdDoc ''
Branch to track
Technically speaking any ref can be specified here, as this is
@ -113,7 +113,7 @@ in
default = "hourly";
description = ''
description = lib.mdDoc ''
The schedule on which to run the `self-deploy` service. Format
specified by `systemd.time 7`.

4
nixos/modules/services/web-apps/hedgedoc.nix
View file

@ -937,7 +937,7 @@ in
id = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
Attribute map for `id'.
Defaults to `NameID' of SAML response.
'';
@ -945,7 +945,7 @@ in
username = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
Attribute map for `username'.
Defaults to `NameID' of SAML response.
'';

2
nixos/modules/services/web-apps/nexus.nix
View file

@ -93,7 +93,7 @@ in
'''
'';
description = ''
description = lib.mdDoc ''
Options for the JVM written to `nexus.jvmopts`.
Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment)
for further information.

2
nixos/modules/services/web-servers/apache-httpd/location-options.nix
View file

@ -43,7 +43,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
Order of this location block in relation to the others in the vhost.
The semantics are the same as with `lib.mkOrder`. Smaller values have
a greater priority.

2
nixos/modules/services/web-servers/darkhttpd.nix
View file

@ -29,7 +29,7 @@ in {
address = mkOption {
default = "127.0.0.1";
type = str;
description = ''
description = lib.mdDoc ''
Address to listen on.
Pass `all` to listen on all interfaces.
'';

2
nixos/modules/services/web-servers/nginx/location-options.nix
View file

@ -122,7 +122,7 @@ with lib;
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
Order of this location block in relation to the others in the vhost.
The semantics are the same as with `lib.mkOrder`. Smaller values have
a greater priority.

4
nixos/modules/services/web-servers/tomcat.nix
View file

@ -34,7 +34,7 @@ in
purifyOnStart = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
On startup, the `baseDir` directory is populated with various files,
subdirectories and symlinks. If this option is enabled, these items
(except for the `logs` and `work` subdirectories) are first removed.
@ -46,7 +46,7 @@ in
baseDir = mkOption {
type = lib.types.path;
default = "/var/tomcat";
description = ''
description = lib.mdDoc ''
Location where Tomcat stores configuration files, web applications
and logfiles. Note that it is partially cleared on each service startup
if `purifyOnStart` is enabled.

2
nixos/modules/services/x11/desktop-managers/phosh.nix
View file

@ -24,7 +24,7 @@ let
phocConfigType = types.submodule {
options = {
xwayland = mkOption {
description = ''
description = lib.mdDoc ''
Whether to enable XWayland support.
To start XWayland immediately, use `immediate`.

2
nixos/modules/system/boot/kernel_config.nix
View file

@ -91,7 +91,7 @@ in
USB? y
DEBUG n
'';
description = ''
description = lib.mdDoc ''
The result of converting the structured kernel configuration in settings
to an intermediate string that can be parsed by generate-config.pl to
answer the kernel `make defconfig`.

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

@ -426,7 +426,7 @@ in
type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str);
default = "disabled";
example = [ "tank" "dozer" ];
description = ''
description = lib.mdDoc ''
After importing, expand each device in the specified pools.
Set the value to the plain string "all" to expand all pools on boot:

8
nixos/modules/tasks/network-interfaces.nix
View file

@ -785,7 +785,7 @@ in
default = null;
example = "fast";
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
DEPRECATED, use `driverOptions`.
Option specifying the rate in which we'll ask our link partner
to transmit LACPDU packets in 802.3ad mode.
@ -796,7 +796,7 @@ in
default = null;
example = 100;
type = types.nullOr types.int;
description = ''
description = lib.mdDoc ''
DEPRECATED, use `driverOptions`.
Miimon is the number of millisecond in between each round of polling
by the device driver for failed links. By default polling is not
@ -809,7 +809,7 @@ in
default = null;
example = "active-backup";
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
DEPRECATED, use `driverOptions`.
The mode which the bond will be running. The default mode for
the bonding driver is balance-rr, optimizing for throughput.
@ -822,7 +822,7 @@ in
default = null;
example = "layer2+3";
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
DEPRECATED, use `driverOptions`.
Selects the transmit hash policy to use for slave selection in
balance-xor, 802.3ad, and tlb modes.

2
nixos/modules/virtualisation/amazon-options.nix
View file

@ -14,7 +14,7 @@ in {
};
datasets = lib.mkOption {
description = ''
description = lib.mdDoc ''
Datasets to create under the `tank` and `boot` zpools.
**NOTE:** This option is used only at image creation time, and

2
nixos/modules/virtualisation/google-compute-image.nix
View file

@ -29,7 +29,7 @@ in
virtualisation.googleComputeImage.configFile = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
A path to a configuration file which will be placed at `/etc/nixos/configuration.nix`
and be used when switching to a new configuration.
If set to `null`, a default configuration is used, where the only import is

2
nixos/modules/virtualisation/libvirtd.nix
View file

@ -81,7 +81,7 @@ let
type = types.package;
default = pkgs.qemu;
defaultText = literalExpression "pkgs.qemu";
description = ''
description = lib.mdDoc ''
Qemu package to use with libvirt.
`pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86)
`pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures.

2
nixos/modules/virtualisation/openstack-options.nix
View file

@ -15,7 +15,7 @@ in
};
datasets = lib.mkOption {
description = ''
description = lib.mdDoc ''
Datasets to create under the `tank` and `boot` zpools.
**NOTE:** This option is used only at image creation time, and

2
nixos/modules/virtualisation/parallels-guest.nix
View file

@ -23,7 +23,7 @@ in
autoMountShares = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Control prlfsmountd service. When this service is running, shares can not be manually
mounted through `mount -t prl_fs ...` as this service will remount and trample any set options.
Recommended to enable for simple file sharing, but extended share use such as for code should