BoomMicrophone/nixpkgs-suyu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

nixos/*: automatically convert option descriptions

Browse source 
conversions were done using https://github.com/pennae/nix-doc-munge
using (probably) rev f34e145 running

    nix-doc-munge nixos/**/*.nix
    nix-doc-munge --import nixos/**/*.nix

the tool ensures that only changes that could affect the generated
manual *but don't* are committed, other changes require manual review
and are discarded.
This commit is contained in:
pennae 2022-08-28 21:18:44 +02:00
parent 5a643387ec
commit ef176dcf7e
808 changed files with 1523 additions and 1523 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
nixos/lib/systemd-types.nix
View file

@ -37,11 +37,11 @@ rec {
initrdContents = types.attrsOf (types.submodule ({ config, options, name, ... }: {
options = {
enable = mkEnableOption "copying of this file and symlinking it" // { default = true; };
enable = mkEnableOption (lib.mdDoc "copying of this file and symlinking it") // { default = true; };
target = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path of the symlink.
'';
default = name;
@ -50,12 +50,12 @@ rec {
text = mkOption {
default = null;
type = types.nullOr types.lines;
description = "Text of the file.";
description = lib.mdDoc "Text of the file.";
};
source = mkOption {
type = types.path;
description = "Path of the source file.";
description = lib.mdDoc "Path of the source file.";
};
};

180
nixos/lib/systemd-unit-options.nix
View file

@ -37,24 +37,24 @@ in rec {
enable = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
If set to false, this unit will be a symlink to
/dev/null. This is primarily useful to prevent specific
template instances
(e.g. <literal>serial-getty@ttyS0</literal>) from being
started. Note that <literal>enable=true</literal> does not
(e.g. `serial-getty@ttyS0`) from being
started. Note that `enable=true` does not
make a unit start by default at boot; if you want that, see
<literal>wantedBy</literal>.
`wantedBy`.
'';
};
requiredBy = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Units that require (i.e. depend on and need to go down with)
this unit. The discussion under <literal>wantedBy</literal>
applies here as well: inverse <literal>.requires</literal>
this unit. The discussion under `wantedBy`
applies here as well: inverse `.requires`
symlinks are established.
'';
};
@ -62,16 +62,16 @@ in rec {
wantedBy = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Units that want (i.e. depend on) this unit. The standard way
to make a unit start by default at boot is to set this option
to <literal>[ "multi-user.target" ]</literal>. That's despite
to `[ "multi-user.target" ]`. That's despite
the fact that the systemd.unit(5) manpage says this option
goes in the <literal>[Install]</literal> section that controls
the behaviour of <literal>systemctl enable</literal>. Since
goes in the `[Install]` section that controls
the behaviour of `systemctl enable`. Since
such a process is stateful and thus contrary to the design of
NixOS, setting this option instead causes the equivalent
inverse <literal>.wants</literal> symlink to be present,
inverse `.wants` symlink to be present,
establishing the same desired relationship in a stateless way.
'';
};
@ -79,7 +79,7 @@ in rec {
aliases = mkOption {
default = [];
type = types.listOf unitNameType;
description = "Aliases of that unit.";
description = lib.mdDoc "Aliases of that unit.";
};
};
@ -89,7 +89,7 @@ in rec {
text = mkOption {
type = types.nullOr types.str;
default = null;
description = "Text of this systemd unit.";
description = lib.mdDoc "Text of this systemd unit.";
};
unit = mkOption {
@ -105,19 +105,19 @@ in rec {
description = mkOption {
default = "";
type = types.singleLineStr;
description = "Description of this unit used in systemd messages and progress indicators.";
description = lib.mdDoc "Description of this unit used in systemd messages and progress indicators.";
};
documentation = mkOption {
default = [];
type = types.listOf types.str;
description = "A list of URIs referencing documentation for this unit or its configuration.";
description = lib.mdDoc "A list of URIs referencing documentation for this unit or its configuration.";
};
requires = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Start the specified units when this unit is started, and stop
this unit when the specified units are stopped or fail.
'';
@ -126,7 +126,7 @@ in rec {
wants = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Start the specified units when this unit is started.
'';
};
@ -134,7 +134,7 @@ in rec {
after = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
If the specified units are started at the same time as
this unit, delay this unit until they have started.
'';
@ -143,7 +143,7 @@ in rec {
before = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
If the specified units are started at the same time as
this unit, delay them until this unit has started.
'';
@ -152,7 +152,7 @@ in rec {
bindsTo = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Like ‘requires’, but in addition, if the specified units
unexpectedly disappear, this unit will be stopped as well.
'';
@ -161,7 +161,7 @@ in rec {
partOf = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
If the specified units are stopped or restarted, then this
unit is stopped or restarted as well.
'';
@ -170,7 +170,7 @@ in rec {
conflicts = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
If the specified units are started, then this unit is stopped
and vice versa.
'';
@ -179,7 +179,7 @@ in rec {
requisite = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
Similar to requires. However if the units listed are not started,
they will not be started and the transaction will fail.
'';
@ -189,17 +189,17 @@ in rec {
default = {};
example = { RequiresMountsFor = "/data"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Unit]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Unit]` section of the unit. See
{manpage}`systemd.unit(5)` for details.
'';
};
onFailure = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
A list of one or more units that are activated when
this unit enters the "failed" state.
'';
@ -208,7 +208,7 @@ in rec {
onSuccess = mkOption {
default = [];
type = types.listOf unitNameType;
description = ''
description = lib.mdDoc ''
A list of one or more units that are activated when
this unit enters the "inactive" state.
'';
@ -216,7 +216,7 @@ in rec {
startLimitBurst = mkOption {
type = types.int;
description = ''
description = lib.mdDoc ''
Configure unit start rate limiting. Units which are started
more than startLimitBurst times within an interval time
interval are not permitted to start any more.
@ -225,7 +225,7 @@ in rec {
startLimitIntervalSec = mkOption {
type = types.int;
description = ''
description = lib.mdDoc ''
Configure unit start rate limiting. Units which are started
more than startLimitBurst times within an interval time
interval are not permitted to start any more.
@ -244,7 +244,7 @@ in rec {
restartTriggers = mkOption {
default = [];
type = types.listOf types.unspecified;
description = ''
description = lib.mdDoc ''
An arbitrary list of items such as derivations. If any item
in the list changes between reconfigurations, the service will
be restarted.
@ -254,7 +254,7 @@ in rec {
reloadTriggers = mkOption {
default = [];
type = types.listOf unitOption;
description = ''
description = lib.mdDoc ''
An arbitrary list of items such as derivations. If any item
in the list changes between reconfigurations, the service will
be reloaded. If anything but a reload trigger changes in the
@ -272,16 +272,16 @@ in rec {
default = {};
type = with types; attrsOf (nullOr (oneOf [ str path package ]));
example = { PATH = "/foo/bar/bin"; LANG = "nl_NL.UTF-8"; };
description = "Environment variables passed to the service's processes.";
description = lib.mdDoc "Environment variables passed to the service's processes.";
};
path = mkOption {
default = [];
type = with types; listOf (oneOf [ package str ]);
description = ''
Packages added to the service's <envar>PATH</envar>
environment variable. Both the <filename>bin</filename>
and <filename>sbin</filename> subdirectories of each
description = lib.mdDoc ''
Packages added to the service's {env}`PATH`
environment variable. Both the {file}`bin`
and {file}`sbin` subdirectories of each
package are added.
'';
};
@ -292,29 +292,29 @@ in rec {
{ RestartSec = 5;
};
type = types.addCheck (types.attrsOf unitOption) checkService;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Service]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Service]` section of the unit. See
{manpage}`systemd.service(5)` for details.
'';
};
script = mkOption {
type = types.lines;
default = "";
description = "Shell commands executed as the service's main process.";
description = lib.mdDoc "Shell commands executed as the service's main process.";
};
scriptArgs = mkOption {
type = types.str;
default = "";
description = "Arguments passed to the main process script.";
description = lib.mdDoc "Arguments passed to the main process script.";
};
preStart = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands executed before the service's main process
is started.
'';
@ -323,7 +323,7 @@ in rec {
postStart = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands executed after the service's main process
is started.
'';
@ -332,7 +332,7 @@ in rec {
reload = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands executed when the service's main process
is reloaded.
'';
@ -341,7 +341,7 @@ in rec {
preStop = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands executed to stop the service.
'';
};
@ -349,7 +349,7 @@ in rec {
postStop = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands executed after the service's main process
has exited.
'';
@ -403,7 +403,7 @@ in rec {
restartIfChanged = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether the service should be restarted during a NixOS
configuration switch if its definition has changed.
'';
@ -412,14 +412,14 @@ in rec {
reloadIfChanged = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether the service should be reloaded during a NixOS
configuration switch if its definition has changed. If
enabled, the value of <option>restartIfChanged</option> is
enabled, the value of {option}`restartIfChanged` is
ignored.
This option should not be used anymore in favor of
<option>reloadTriggers</option> which allows more granular
{option}`reloadTriggers` which allows more granular
control of when a service is reloaded and when a service
is restarted.
'';
@ -428,14 +428,14 @@ in rec {
stopIfChanged = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
If set, a changed unit is restarted by calling
<command>systemctl stop</command> in the old configuration,
then <command>systemctl start</command> in the new one.
{command}`systemctl stop` in the old configuration,
then {command}`systemctl start` in the new one.
Otherwise, it is restarted in a single step using
<command>systemctl restart</command> in the new configuration.
{command}`systemctl restart` in the new configuration.
The latter is less correct because it runs the
<literal>ExecStop</literal> commands from the new
`ExecStop` commands from the new
configuration.
'';
};
@ -444,12 +444,12 @@ in rec {
type = with types; either str (listOf str);
default = [];
example = "Sun 14:00:00";
description = ''
description = lib.mdDoc ''
Automatically start this unit at the given date/time, which
must be in the format described in
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. This is equivalent
{manpage}`systemd.time(7)`. This is equivalent
to adding a corresponding timer unit with
<option>OnCalendar</option> set to the value given here.
{option}`OnCalendar` set to the value given here.
'';
apply = v: if isList v then v else [ v ];
};
@ -471,9 +471,9 @@ in rec {
default = [];
type = types.listOf types.str;
example = [ "0.0.0.0:993" "/run/my-socket" ];
description = ''
For each item in this list, a <literal>ListenStream</literal>
option in the <literal>[Socket]</literal> section will be created.
description = lib.mdDoc ''
For each item in this list, a `ListenStream`
option in the `[Socket]` section will be created.
'';
};
@ -481,9 +481,9 @@ in rec {
default = [];
type = types.listOf types.str;
example = [ "0.0.0.0:993" "/run/my-socket" ];
description = ''
For each item in this list, a <literal>ListenDatagram</literal>
option in the <literal>[Socket]</literal> section will be created.
description = lib.mdDoc ''
For each item in this list, a `ListenDatagram`
option in the `[Socket]` section will be created.
'';
};
@ -491,10 +491,10 @@ in rec {
default = {};
example = { ListenStream = "/run/my-socket"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Socket]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Socket]` section of the unit. See
{manpage}`systemd.socket(5)` for details.
'';
};
};
@ -523,11 +523,11 @@ in rec {
default = {};
example = { OnCalendar = "Sun 14:00:00"; Unit = "foo.service"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Timer]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.
`[Timer]` section of the unit. See
{manpage}`systemd.timer(5)` and
{manpage}`systemd.time(7)` for details.
'';
};
@ -556,10 +556,10 @@ in rec {
default = {};
example = { PathChanged = "/some/path"; Unit = "changedpath.service"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Path]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Path]` section of the unit. See
{manpage}`systemd.path(5)` for details.
'';
};
@ -587,13 +587,13 @@ in rec {
what = mkOption {
example = "/dev/sda1";
type = types.str;
description = "Absolute path of device node, file or other resource. (Mandatory)";
description = lib.mdDoc "Absolute path of device node, file or other resource. (Mandatory)";
};
where = mkOption {
example = "/mnt";
type = types.str;
description = ''
description = lib.mdDoc ''
Absolute path of a directory of the mount point.
Will be created if it doesn't exist. (Mandatory)
'';
@ -603,24 +603,24 @@ in rec {
default = "";
example = "ext4";
type = types.str;
description = "File system type.";
description = lib.mdDoc "File system type.";
};
options = mkOption {
default = "";
example = "noatime";
type = types.commas;
description = "Options used to mount the file system.";
description = lib.mdDoc "Options used to mount the file system.";
};
mountConfig = mkOption {
default = {};
example = { DirectoryMode = "0775"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Mount]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Mount]` section of the unit. See
{manpage}`systemd.mount(5)` for details.
'';
};
@ -647,7 +647,7 @@ in rec {
where = mkOption {
example = "/mnt";
type = types.str;
description = ''
description = lib.mdDoc ''
Absolute path of a directory of the mount point.
Will be created if it doesn't exist. (Mandatory)
'';
@ -657,10 +657,10 @@ in rec {
default = {};
example = { DirectoryMode = "0775"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Automount]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Automount]` section of the unit. See
{manpage}`systemd.automount(5)` for details.
'';
};
@ -688,10 +688,10 @@ in rec {
default = {};
example = { MemoryMax = "2G"; };
type = types.attrsOf unitOption;
description = ''
description = lib.mdDoc ''
Each attribute in this set specifies an option in the
<literal>[Slice]</literal> section of the unit. See
<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.
`[Slice]` section of the unit. See
{manpage}`systemd.slice(5)` for details.
'';
};

6
nixos/maintainers/scripts/openstack/openstack-image-zfs.nix
View file

@ -16,20 +16,20 @@ in
options.openstackImage = {
name = mkOption {
type = types.str;
description = "The name of the generated derivation";
description = lib.mdDoc "The name of the generated derivation";
default = "nixos-openstack-image-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
};
sizeMB = mkOption {
type = types.int;
default = 8192;
description = "The size in MB of the image";
description = lib.mdDoc "The size in MB of the image";
};
format = mkOption {
type = types.enum [ "raw" "qcow2" ];
default = "qcow2";
description = "The image format to output";
description = lib.mdDoc "The image format to output";
};
};

2
nixos/modules/config/iproute2.nix
View file

@ -7,7 +7,7 @@ let
in
{
options.networking.iproute2 = {
enable = mkEnableOption "copy IP route configuration files";
enable = mkEnableOption (lib.mdDoc "copy IP route configuration files");
rttablesExtraConfig = mkOption {
type = types.lines;
default = "";

2
nixos/modules/config/krb5/default.nix
View file

@ -78,7 +78,7 @@ in {
options = {
krb5 = {
enable = mkEnableOption "building krb5.conf, configuration file for Kerberos V";
enable = mkEnableOption (lib.mdDoc "building krb5.conf, configuration file for Kerberos V");
kerberos = mkOption {
type = types.package;

2
nixos/modules/config/ldap.nix
View file

@ -59,7 +59,7 @@ in
users.ldap = {
enable = mkEnableOption "authentication against an LDAP server";
enable = mkEnableOption (lib.mdDoc "authentication against an LDAP server");
loginPam = mkOption {
type = types.bool;

102
nixos/modules/config/mysql.nix
View file

@ -8,54 +8,54 @@ in
{
options = {
users.mysql = {
enable = mkEnableOption "Authentication against a MySQL/MariaDB database";
enable = mkEnableOption (lib.mdDoc "Authentication against a MySQL/MariaDB database");
host = mkOption {
type = types.str;
example = "localhost";
description = "The hostname of the MySQL/MariaDB server";
description = lib.mdDoc "The hostname of the MySQL/MariaDB server";
};
database = mkOption {
type = types.str;
example = "auth";
description = "The name of the database containing the users";
description = lib.mdDoc "The name of the database containing the users";
};
user = mkOption {
type = types.str;
example = "nss-user";
description = "The username to use when connecting to the database";
description = lib.mdDoc "The username to use when connecting to the database";
};
passwordFile = mkOption {
type = types.path;
example = "/run/secrets/mysql-auth-db-passwd";
description = "The path to the file containing the password for the user";
description = lib.mdDoc "The path to the file containing the password for the user";
};
pam = mkOption {
description = "Settings for <literal>pam_mysql</literal>";
description = lib.mdDoc "Settings for `pam_mysql`";
type = types.submodule {
options = {
table = mkOption {
type = types.str;
example = "users";
description = "The name of table that maps unique login names to the passwords.";
description = lib.mdDoc "The name of table that maps unique login names to the passwords.";
};
updateTable = mkOption {
type = types.nullOr types.str;
default = null;
example = "users_updates";
description = ''
description = lib.mdDoc ''
The name of the table used for password alteration. If not defined, the value
of the <literal>table</literal> option will be used instead.
of the `table` option will be used instead.
'';
};
userColumn = mkOption {
type = types.str;
example = "username";
description = "The name of the column that contains a unix login name.";
description = lib.mdDoc "The name of the column that contains a unix login name.";
};
passwordColumn = mkOption {
type = types.str;
example = "password";
description = "The name of the column that contains a (encrypted) password string.";
description = lib.mdDoc "The name of the column that contains a (encrypted) password string.";
};
statusColumn = mkOption {
type = types.nullOr types.str;
@ -123,27 +123,27 @@ in
type = types.nullOr (types.enum [ "md5" "sha256" "sha512" "blowfish" ]);
default = null;
example = "blowfish";
description = "The default encryption method to use for <literal>passwordCrypt = 1</literal>.";
description = lib.mdDoc "The default encryption method to use for `passwordCrypt = 1`.";
};
where = mkOption {
type = types.nullOr types.str;
default = null;
example = "host.name='web' AND user.active=1";
description = "Additional criteria for the query.";
description = lib.mdDoc "Additional criteria for the query.";
};
verbose = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If enabled, produces logs with detailed messages that describes what
<literal>pam_mysql</literal> is doing. May be useful for debugging.
`pam_mysql` is doing. May be useful for debugging.
'';
};
disconnectEveryOperation = mkOption {
type = types.bool;
default = false;
description = ''
By default, <literal>pam_mysql</literal> keeps the connection to the MySQL
description = lib.mdDoc ''
By default, `pam_mysql` keeps the connection to the MySQL
database until the session is closed. If this option is set to true it
disconnects every time the PAM operation has finished. This option may
be useful in case the session lasts quite long.
@ -153,17 +153,17 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = "Enables logging of authentication attempts in the MySQL database.";
description = lib.mdDoc "Enables logging of authentication attempts in the MySQL database.";
};
table = mkOption {
type = types.str;
example = "logs";
description = "The name of the table to which logs are written.";
description = lib.mdDoc "The name of the table to which logs are written.";
};
msgColumn = mkOption {
type = types.str;
example = "msg";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the description
of the performed operation is stored.
'';
@ -171,7 +171,7 @@ in
userColumn = mkOption {
type = types.str;
example = "user";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the name of the
user being authenticated is stored.
'';
@ -179,16 +179,16 @@ in
pidColumn = mkOption {
type = types.str;
example = "pid";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the pid of the
process utilising the <literal>pam_mysql's</literal> authentication
process utilising the `pam_mysql's` authentication
service is stored.
'';
};
hostColumn = mkOption {
type = types.str;
example = "host";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the name of the user
being authenticated is stored.
'';
@ -196,16 +196,16 @@ in
rHostColumn = mkOption {
type = types.str;
example = "rhost";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the name of the remote
host that initiates the session is stored. The value is supposed to be
set by the PAM-aware application with <literal>pam_set_item(PAM_RHOST)</literal>.
set by the PAM-aware application with `pam_set_item(PAM_RHOST)`.
'';
};
timeColumn = mkOption {
type = types.str;
example = "timestamp";
description = ''
description = lib.mdDoc ''
The name of the column in the log table to which the timestamp of the
log entry is stored.
'';
@ -215,11 +215,11 @@ in
};
};
nss = mkOption {
description = ''
Settings for <literal>libnss-mysql</literal>.
description = lib.mdDoc ''
Settings for `libnss-mysql`.
All examples are from the <link xlink:href="https://github.com/saknopper/libnss-mysql/tree/master/sample/minimal">minimal example</link>
of <literal>libnss-mysql</literal>, but they are modified with NixOS paths for bash.
All examples are from the [minimal example](https://github.com/saknopper/libnss-mysql/tree/master/sample/minimal)
of `libnss-mysql`, but they are modified with NixOS paths for bash.
'';
type = types.submodule {
options = {
@ -232,8 +232,8 @@ in
WHERE username='%1$s' \
LIMIT 1
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getpwnam.3.html">getpwnam</link>
description = lib.mdDoc ''
SQL query for the [getpwnam](https://man7.org/linux/man-pages/man3/getpwnam.3.html)
syscall.
'';
};
@ -246,8 +246,8 @@ in
WHERE uid='%1$u' \
LIMIT 1
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getpwuid.3.html">getpwuid</link>
description = lib.mdDoc ''
SQL query for the [getpwuid](https://man7.org/linux/man-pages/man3/getpwuid.3.html)
syscall.
'';
};
@ -260,8 +260,8 @@ in
WHERE username='%1$s' \
LIMIT 1
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getspnam.3.html">getspnam</link>
description = lib.mdDoc ''
SQL query for the [getspnam](https://man7.org/linux/man-pages/man3/getspnam.3.html)
syscall.
'';
};
@ -271,8 +271,8 @@ in
example = literalExpression ''
SELECT username,'x',uid,'5000','MySQL User', CONCAT('/home/',username),'/run/sw/current-system/bin/bash' FROM users
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getpwent.3.html">getpwent</link>
description = lib.mdDoc ''
SQL query for the [getpwent](https://man7.org/linux/man-pages/man3/getpwent.3.html)
syscall.
'';
};
@ -282,8 +282,8 @@ in
example = literalExpression ''
SELECT username,password,'1','0','99999','0','0','-1','0' FROM users
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getspent.3.html">getspent</link>
description = lib.mdDoc ''
SQL query for the [getspent](https://man7.org/linux/man-pages/man3/getspent.3.html)
syscall.
'';
};
@ -293,8 +293,8 @@ in
example = literalExpression ''
SELECT name,password,gid FROM groups WHERE name='%1$s' LIMIT 1
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getgrnam.3.html">getgrnam</link>
description = lib.mdDoc ''
SQL query for the [getgrnam](https://man7.org/linux/man-pages/man3/getgrnam.3.html)
syscall.
'';
};
@ -304,8 +304,8 @@ in
example = literalExpression ''
SELECT name,password,gid FROM groups WHERE gid='%1$u' LIMIT 1
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getgrgid.3.html">getgrgid</link>
description = lib.mdDoc ''
SQL query for the [getgrgid](https://man7.org/linux/man-pages/man3/getgrgid.3.html)
syscall.
'';
};
@ -315,8 +315,8 @@ in
example = literalExpression ''
SELECT name,password,gid FROM groups
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/getgrent.3.html">getgrent</link>
description = lib.mdDoc ''
SQL query for the [getgrent](https://man7.org/linux/man-pages/man3/getgrent.3.html)
syscall.
'';
};
@ -326,8 +326,8 @@ in
example = literalExpression ''
SELECT username FROM grouplist WHERE gid='%1$u'
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/memsbygid.3.html">memsbygid</link>
description = lib.mdDoc ''
SQL query for the [memsbygid](https://man7.org/linux/man-pages/man3/memsbygid.3.html)
syscall.
'';
};
@ -337,8 +337,8 @@ in
example = literalExpression ''
SELECT gid FROM grouplist WHERE username='%1$s'
'';
description = ''
SQL query for the <link xlink:href="https://man7.org/linux/man-pages/man3/gidsbymem.3.html">gidsbymem</link>
description = lib.mdDoc ''
SQL query for the [gidsbymem](https://man7.org/linux/man-pages/man3/gidsbymem.3.html)
syscall.
'';
};

8
nixos/modules/config/pulseaudio.nix
View file

@ -190,17 +190,17 @@ in {
zeroconf = {
discovery.enable =
mkEnableOption "discovery of pulseaudio sinks in the local network";
mkEnableOption (lib.mdDoc "discovery of pulseaudio sinks in the local network");
publish.enable =
mkEnableOption "publishing the pulseaudio sink in the local network";
mkEnableOption (lib.mdDoc "publishing the pulseaudio sink in the local network");
};
# TODO: enable by default?
tcp = {
enable = mkEnableOption "tcp streaming support";
enable = mkEnableOption (lib.mdDoc "tcp streaming support");
anonymousClients = {
allowAll = mkEnableOption "all anonymous clients to stream to the server";
allowAll = mkEnableOption (lib.mdDoc "all anonymous clients to stream to the server");
allowedIpRanges = mkOption {
type = types.listOf types.str;
default = [];

2
nixos/modules/config/qt5.nix
View file

@ -27,7 +27,7 @@ in
options = {
qt5 = {
enable = mkEnableOption "Qt5 theming configuration";
enable = mkEnableOption (lib.mdDoc "Qt5 theming configuration");
platformTheme = mkOption {
type = types.enum [

4
nixos/modules/config/swap.nix
View file

@ -73,8 +73,8 @@ let
label = mkOption {
example = "swap";
type = types.str;
description = ''
Label of the device. Can be used instead of <varname>device</varname>.
description = lib.mdDoc ''
Label of the device. Can be used instead of {var}`device`.
'';
};

2
nixos/modules/config/xdg/portal.nix
View file

@ -33,7 +33,7 @@ in
options.xdg.portal = {
enable =
mkEnableOption ''<link xlink:href="https://github.com/flatpak/xdg-desktop-portal">xdg desktop integration</link>'' // {
mkEnableOption (lib.mdDoc ''[xdg desktop integration](https://github.com/flatpak/xdg-desktop-portal)'') // {
default = false;
};

8
nixos/modules/config/xdg/portals/lxqt.nix
View file

@ -12,13 +12,13 @@ in
};
options.xdg.portal.lxqt = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
the desktop portal for the LXQt desktop environment.
This will add the <literal>lxqt.xdg-desktop-portal-lxqt</literal>
This will add the `lxqt.xdg-desktop-portal-lxqt`
package (with the extra Qt styles) into the
<option>xdg.portal.extraPortals</option> option
'';
{option}`xdg.portal.extraPortals` option
'');
styles = mkOption {
type = types.listOf types.package;

8
nixos/modules/config/xdg/portals/wlr.nix
View file

@ -14,13 +14,13 @@ in
};
options.xdg.portal.wlr = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
desktop portal for wlroots-based desktops
This will add the <literal>xdg-desktop-portal-wlr</literal> package into
the <option>xdg.portal.extraPortals</option> option, and provide the
This will add the `xdg-desktop-portal-wlr` package into
the {option}`xdg.portal.extraPortals` option, and provide the
configuration file
'';
'');
settings = mkOption {
description = lib.mdDoc ''

4
nixos/modules/hardware/brillo.nix
View file

@ -7,10 +7,10 @@ in
{
options = {
hardware.brillo = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
Enable brillo in userspace.
This will allow brightness control from users in the video group.
'';
'');
};
};

2
nixos/modules/hardware/ckb-next.nix
View file

@ -13,7 +13,7 @@ in
];
options.hardware.ckb-next = {
enable = mkEnableOption "the Corsair keyboard/mouse driver";
enable = mkEnableOption (lib.mdDoc "the Corsair keyboard/mouse driver");
gid = mkOption {
type = types.nullOr types.int;

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

@ -7,15 +7,15 @@ let
in
{
options.programs.corectrl = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
A tool to overclock amd graphics cards and processors.
Add your user to the corectrl group to run corectrl without needing to enter your password
'';
'');
gpuOverclock = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
true
'';
'');
ppfeaturemask = mkOption {
type = types.str;
default = "0xfffd7fff";

2
nixos/modules/hardware/cpu/amd-sev.nix
View file

@ -6,7 +6,7 @@ let
in
with lib; {
options.hardware.cpu.amd.sev = {
enable = mkEnableOption "access to the AMD SEV device";
enable = mkEnableOption (lib.mdDoc "access to the AMD SEV device");
user = mkOption {
description = lib.mdDoc "Owner to assign to the SEV device.";
type = types.str;

2
nixos/modules/hardware/cpu/intel-sgx.nix
View file

@ -20,7 +20,7 @@ in
};
options.hardware.cpu.intel.sgx.provision = {
enable = mkEnableOption "access to the Intel SGX provisioning device";
enable = mkEnableOption (lib.mdDoc "access to the Intel SGX provisioning device");
user = mkOption {
description = lib.mdDoc "Owner to assign to the SGX provisioning device.";
type = types.str;

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

@ -3,7 +3,7 @@ let
cfg = config.hardware.flirc;
in
{
options.hardware.flirc.enable = lib.mkEnableOption "software to configure a Flirc USB device";
options.hardware.flirc.enable = lib.mkEnableOption (lib.mdDoc "software to configure a Flirc USB device");
config = lib.mkIf cfg.enable {
environment.systemPackages = [ pkgs.flirc ];

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

@ -7,7 +7,7 @@ let
in
{
options.hardware.gkraken = {
enable = mkEnableOption "gkraken's udev rules for NZXT AIO liquid coolers";
enable = mkEnableOption (lib.mdDoc "gkraken's udev rules for NZXT AIO liquid coolers");
};
config = mkIf cfg.enable {

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

@ -28,7 +28,7 @@ let
cfg = config.hardware.gpgSmartcards;
in {
options.hardware.gpgSmartcards = {
enable = mkEnableOption "udev rules for gnupg smart cards";
enable = mkEnableOption (lib.mdDoc "udev rules for gnupg smart cards");
};
config = mkIf cfg.enable {

4
nixos/modules/hardware/i2c.nix
View file

@ -8,11 +8,11 @@ in
{
options.hardware.i2c = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
i2c devices support. By default access is granted to users in the "i2c"
group (will be created if non-existent) and any user with a seat, meaning
logged on the computer locally.
'';
'');
group = mkOption {
type = types.str;

2
nixos/modules/hardware/keyboard/teck.nix
View file

@ -6,7 +6,7 @@ let
in
{
options.hardware.keyboard.teck = {
enable = mkEnableOption "non-root access to the firmware of TECK keyboards";
enable = mkEnableOption (lib.mdDoc "non-root access to the firmware of TECK keyboards");
};
config = mkIf cfg.enable {

4
nixos/modules/hardware/keyboard/uhk.nix
View file

@ -6,12 +6,12 @@ let
in
{
options.hardware.keyboard.uhk = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
non-root access to the firmware of UHK keyboards.
You need it when you want to flash a new firmware on the keyboard.
Access to the keyboard is granted to users in the "input" group.
You may want to install the uhk-agent package.
'';
'');
};

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

@ -11,7 +11,7 @@ in {
];
options.hardware.ksm = {
enable = mkEnableOption "Kernel Same-Page Merging";
enable = mkEnableOption (lib.mdDoc "Kernel Same-Page Merging");
sleep = mkOption {
type = types.nullOr types.int;
default = null;

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

@ -6,7 +6,7 @@ let
cfg = config.hardware.ledger;
in {
options.hardware.ledger.enable = mkEnableOption "udev rules for Ledger devices";
options.hardware.ledger.enable = mkEnableOption (lib.mdDoc "udev rules for Ledger devices");
config = mkIf cfg.enable {
services.udev.packages = [ pkgs.ledger-udev-rules ];

4
nixos/modules/hardware/logitech.nix
View file

@ -19,7 +19,7 @@ in
options.hardware.logitech = {
lcd = {
enable = mkEnableOption "Logitech LCD Devices";
enable = mkEnableOption (lib.mdDoc "Logitech LCD Devices");
startWhenNeeded = mkOption {
type = types.bool;
@ -41,7 +41,7 @@ in
};
wireless = {
enable = mkEnableOption "Logitech Wireless Devices";
enable = mkEnableOption (lib.mdDoc "Logitech Wireless Devices");
enableGraphical = mkOption {
type = types.bool;

4
nixos/modules/hardware/openrazer.nix
View file

@ -49,9 +49,9 @@ in
{
options = {
hardware.openrazer = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
OpenRazer drivers and userspace daemon.
'';
'');
verboseLogging = mkOption {
type = types.bool;

2
nixos/modules/hardware/raid/hpsa.nix
View file

@ -48,7 +48,7 @@ in {
options = {
hardware.raid.HPSmartArray = {
enable = mkEnableOption "HP Smart Array kernel modules and CLI utility";
enable = mkEnableOption (lib.mdDoc "HP Smart Array kernel modules and CLI utility");
};
};

2
nixos/modules/hardware/saleae-logic.nix
View file

@ -5,7 +5,7 @@ let
in
{
options.hardware.saleae-logic = {
enable = lib.mkEnableOption "udev rules for Saleae Logic devices";
enable = lib.mkEnableOption (lib.mdDoc "udev rules for Saleae Logic devices");
package = lib.mkOption {
type = lib.types.package;

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

@ -36,7 +36,7 @@ in
meta.maintainers = with lib.maintainers; [ peterhoeg ];
options.hardware.sata.timeout = {
enable = mkEnableOption "SATA drive timeouts";
enable = mkEnableOption (lib.mdDoc "SATA drive timeouts");
deciSeconds = mkOption {
example = 70;

2
nixos/modules/hardware/system-76.nix
View file

@ -57,7 +57,7 @@ let
in {
options = {
hardware.system76 = {
enableAll = mkEnableOption "all recommended configuration for system76 systems";
enableAll = mkEnableOption (lib.mdDoc "all recommended configuration for system76 systems");
firmware-daemon.enable = mkOption {
default = cfg.enableAll;

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

@ -10,7 +10,7 @@ let
};
in {
options.hardware.ubertooth = {
enable = mkEnableOption "Enable the Ubertooth software and its udev rules.";
enable = mkEnableOption (lib.mdDoc "Enable the Ubertooth software and its udev rules.");
group = mkOption {
type = types.str;

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

@ -4,7 +4,7 @@ let
cfg = config.hardware.uinput;
in {
options.hardware.uinput = {
enable = lib.mkEnableOption "uinput support";
enable = lib.mkEnableOption (lib.mdDoc "uinput support");
};
config = lib.mkIf cfg.enable {

2
nixos/modules/hardware/video/capture/mwprocapture.nix
View file

@ -12,7 +12,7 @@ in
{
options.hardware.mwProCapture.enable = mkEnableOption "Magewell Pro Capture family kernel module";
options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "Magewell Pro Capture family kernel module");
config = mkIf cfg.enable {

2
nixos/modules/hardware/video/hidpi.nix
View file

@ -2,7 +2,7 @@
with lib;
{
options.hardware.video.hidpi.enable = mkEnableOption "Font/DPI configuration optimized for HiDPI displays";
options.hardware.video.hidpi.enable = mkEnableOption (lib.mdDoc "Font/DPI configuration optimized for HiDPI displays");
config = mkIf config.hardware.video.hidpi.enable {
console.font = lib.mkDefault "${pkgs.terminus_font}/share/consolefonts/ter-v32n.psf.gz";

2
nixos/modules/hardware/video/switcheroo-control.nix
View file

@ -6,7 +6,7 @@ let
cfg = config.services.switcherooControl;
in {
options.services.switcherooControl = {
enable = mkEnableOption "switcheroo-control, a D-Bus service to check the availability of dual-GPU";
enable = mkEnableOption (lib.mdDoc "switcheroo-control, a D-Bus service to check the availability of dual-GPU");
};
config = mkIf cfg.enable {

2
nixos/modules/hardware/video/webcam/facetimehd.nix
View file

@ -12,7 +12,7 @@ in
{
options.hardware.facetimehd.enable = mkEnableOption "facetimehd kernel module";
options.hardware.facetimehd.enable = mkEnableOption (lib.mdDoc "facetimehd kernel module");
options.hardware.facetimehd.withCalibration = mkOption {
default = false;

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

@ -3,7 +3,7 @@
with lib;
{
options.hardware.wooting.enable =
mkEnableOption "Enable support for Wooting keyboards";
mkEnableOption (lib.mdDoc "Enable support for Wooting keyboards");
config = mkIf config.hardware.wooting.enable {
environment.systemPackages = [ pkgs.wootility ];

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

@ -6,7 +6,7 @@ let
in
{
options.hardware.xone = {
enable = mkEnableOption "the xone driver for Xbox One and Xbobx Series X|S accessories";
enable = mkEnableOption (lib.mdDoc "the xone driver for Xbox One and Xbobx Series X|S accessories");
};
config = mkIf cfg.enable {

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

@ -6,7 +6,7 @@ let
in
{
options.hardware.xpadneo = {
enable = mkEnableOption "the xpadneo driver for Xbox One wireless controllers";
enable = mkEnableOption (lib.mdDoc "the xpadneo driver for Xbox One wireless controllers");
};
config = mkIf cfg.enable {

2
nixos/modules/i18n/input-method/fcitx5.nix
View file

@ -20,7 +20,7 @@ in {
'';
};
enableRimeData = mkEnableOption "default rime-data with fcitx5-rime";
enableRimeData = mkEnableOption (lib.mdDoc "default rime-data with fcitx5-rime");
};
};

2
nixos/modules/misc/man-db.nix
View file

@ -7,7 +7,7 @@ in
{
options = {
documentation.man.man-db = {
enable = lib.mkEnableOption "man-db as the default man page viewer" // {
enable = lib.mkEnableOption (lib.mdDoc "man-db as the default man page viewer") // {
default = config.documentation.man.enable;
defaultText = lib.literalExpression "config.documentation.man.enable";
example = false;

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

@ -10,7 +10,7 @@ in {
options = {
documentation.man.mandoc = {
enable = lib.mkEnableOption "mandoc as the default man page viewer";
enable = lib.mkEnableOption (lib.mdDoc "mandoc as the default man page viewer");
manPath = lib.mkOption {
type = with lib.types; listOf str;

2
nixos/modules/misc/nixops-autoluks.nix
View file

@ -5,7 +5,7 @@ let
inherit (config.nixops) enableDeprecatedAutoLuks;
in {
options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption "Enable the deprecated NixOps AutoLuks module";
options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption (lib.mdDoc "Enable the deprecated NixOps AutoLuks module");
config = {
assertions = [

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

@ -8,7 +8,7 @@ in
{
options = {
environment.wordlist = {
enable = mkEnableOption "environment variables for lists of words";
enable = mkEnableOption (lib.mdDoc "environment variables for lists of words");
lists = mkOption {
type = types.attrsOf (types.nonEmptyListOf types.path);

2
nixos/modules/programs/_1password-gui.nix
View file

@ -16,7 +16,7 @@ in
options = {
programs._1password-gui = {
enable = mkEnableOption "the 1Password GUI application";
enable = mkEnableOption (lib.mdDoc "the 1Password GUI application");
polkitPolicyOwners = mkOption {
type = types.listOf types.str;

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

@ -16,7 +16,7 @@ in
options = {
programs._1password = {
enable = mkEnableOption "the 1Password CLI tool";
enable = mkEnableOption (lib.mdDoc "the 1Password CLI tool");
package = mkPackageOption pkgs "1Password CLI" {
default = [ "_1password" ];

2
nixos/modules/programs/appgate-sdp.nix
View file

@ -5,7 +5,7 @@ with lib;
{
options = {
programs.appgate-sdp = {
enable = mkEnableOption "AppGate SDP VPN client";
enable = mkEnableOption (lib.mdDoc "AppGate SDP VPN client");
};
};

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

@ -14,7 +14,7 @@ in
programs.atop = rec {
enable = mkEnableOption "Atop";
enable = mkEnableOption (lib.mdDoc "Atop");
package = mkOption {
type = types.package;

2
nixos/modules/programs/bash-my-aws.nix
View file

@ -13,7 +13,7 @@ in
{
options = {
programs.bash-my-aws = {
enable = mkEnableOption "bash-my-aws";
enable = mkEnableOption (lib.mdDoc "bash-my-aws");
};
};

2
nixos/modules/programs/bash/bash-completion.nix
View file

@ -7,7 +7,7 @@ let
in
{
options = {
programs.bash.enableCompletion = mkEnableOption "Bash completion for all interactive bash shells" // {
programs.bash.enableCompletion = mkEnableOption (lib.mdDoc "Bash completion for all interactive bash shells") // {
default = true;
};
};

2
nixos/modules/programs/bash/ls-colors.nix
View file

@ -7,7 +7,7 @@ let
in
{
options = {
programs.bash.enableLsColors = mkEnableOption "extra colors in directory listings" // {
programs.bash.enableLsColors = mkEnableOption (lib.mdDoc "extra colors in directory listings") // {
default = true;
};
};

4
nixos/modules/programs/bash/undistract-me.nix
View file

@ -8,9 +8,9 @@ in
{
options = {
programs.bash.undistractMe = {
enable = mkEnableOption "notifications when long-running terminal commands complete";
enable = mkEnableOption (lib.mdDoc "notifications when long-running terminal commands complete");
playSound = mkEnableOption "notification sounds when long-running terminal commands complete";
playSound = mkEnableOption (lib.mdDoc "notification sounds when long-running terminal commands complete");
timeout = mkOption {
default = 10;

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

@ -1,6 +1,6 @@
{ config, pkgs, lib, ... }:
{
options.programs.bcc.enable = lib.mkEnableOption "bcc";
options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc");
config = lib.mkIf config.programs.bcc.enable {
environment.systemPackages = [ pkgs.bcc ];

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

@ -4,7 +4,7 @@ with lib;
{
options.programs.browserpass.enable = mkEnableOption "Browserpass native messaging host";
options.programs.browserpass.enable = mkEnableOption (lib.mdDoc "Browserpass native messaging host");
config = mkIf config.programs.browserpass.enable {
environment.etc = let

4
nixos/modules/programs/calls.nix
View file

@ -7,9 +7,9 @@ let
in {
options = {
programs.calls = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
Whether to enable GNOME calls: a phone dialer and call handler.
'';
'');
};
};

2
nixos/modules/programs/captive-browser.nix
View file

@ -34,7 +34,7 @@ in
options = {
programs.captive-browser = {
enable = mkEnableOption "captive browser";
enable = mkEnableOption (lib.mdDoc "captive browser");
package = mkOption {
type = types.package;

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

@ -6,7 +6,7 @@ let
in {
options.programs.ccache = {
# host configuration
enable = mkEnableOption "CCache";
enable = mkEnableOption (lib.mdDoc "CCache");
cacheDir = mkOption {
type = types.path;
description = lib.mdDoc "CCache directory";

2
nixos/modules/programs/cfs-zen-tweaks.nix
View file

@ -17,7 +17,7 @@ in
};
options = {
programs.cfs-zen-tweaks.enable = mkEnableOption "CFS Zen Tweaks";
programs.cfs-zen-tweaks.enable = mkEnableOption (lib.mdDoc "CFS Zen Tweaks");
};
config = mkIf cfg.enable {

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

@ -19,7 +19,7 @@ in
options = {
programs.chromium = {
enable = mkEnableOption "<command>chromium</command> policies";
enable = mkEnableOption (lib.mdDoc "{command}`chromium` policies");
extensions = mkOption {
type = types.listOf types.str;

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

@ -8,7 +8,7 @@ in
{
options = {
programs.cnping = {
enable = mkEnableOption "Whether to install a setcap wrapper for cnping";
enable = mkEnableOption (lib.mdDoc "Whether to install a setcap wrapper for cnping");
};
};

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

@ -28,7 +28,7 @@ in
options = {
programs.dconf = {
enable = mkEnableOption "dconf";
enable = mkEnableOption (lib.mdDoc "dconf");
profiles = mkOption {
type = types.attrsOf types.path;

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

@ -4,7 +4,7 @@ with lib;
{
options.programs.droidcam = {
enable = mkEnableOption "DroidCam client";
enable = mkEnableOption (lib.mdDoc "DroidCam client");
};
config = lib.mkIf config.programs.droidcam.enable {

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

@ -22,7 +22,7 @@ in {
programs.evince = {
enable = mkEnableOption
"Evince, the GNOME document viewer";
(lib.mdDoc "Evince, the GNOME document viewer");
package = mkOption {
type = types.package;

4
nixos/modules/programs/extra-container.nix
View file

@ -5,10 +5,10 @@ let
cfg = config.programs.extra-container;
in {
options = {
programs.extra-container.enable = mkEnableOption ''
programs.extra-container.enable = mkEnableOption (lib.mdDoc ''
extra-container, a tool for running declarative NixOS containers
without host system rebuilds
'';
'');
};
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.extra-container ];

2
nixos/modules/programs/file-roller.nix
View file

@ -21,7 +21,7 @@ in {
programs.file-roller = {
enable = mkEnableOption "File Roller, an archive manager for GNOME";
enable = mkEnableOption (lib.mdDoc "File Roller, an archive manager for GNOME");
package = mkOption {
type = types.package;

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

@ -32,7 +32,7 @@ let
in {
options.programs.firejail = {
enable = mkEnableOption "firejail";
enable = mkEnableOption (lib.mdDoc "firejail");
wrappedBinaries = mkOption {
type = types.attrsOf (types.either types.path (types.submodule {

2
nixos/modules/programs/flexoptix-app.nix
View file

@ -7,7 +7,7 @@ let
in {
options = {
programs.flexoptix-app = {
enable = mkEnableOption "FLEXOPTIX app + udev rules";
enable = mkEnableOption (lib.mdDoc "FLEXOPTIX app + udev rules");
package = mkOption {
description = lib.mdDoc "FLEXOPTIX app package to use";

4
nixos/modules/programs/gamemode.nix
View file

@ -10,9 +10,9 @@ in
{
options = {
programs.gamemode = {
enable = mkEnableOption "GameMode to optimise system performance on demand";
enable = mkEnableOption (lib.mdDoc "GameMode to optimise system performance on demand");
enableRenice = mkEnableOption "CAP_SYS_NICE on gamemoded to support lowering process niceness" // {
enableRenice = mkEnableOption (lib.mdDoc "CAP_SYS_NICE on gamemoded to support lowering process niceness") // {
default = true;
};

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

@ -11,7 +11,7 @@ in {
};
options = {
programs.geary.enable = mkEnableOption "Geary, a Mail client for GNOME 3";
programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME 3");
};
config = mkIf cfg.enable {

4
nixos/modules/programs/git.nix
View file

@ -9,7 +9,7 @@ in
{
options = {
programs.git = {
enable = mkEnableOption "git";
enable = mkEnableOption (lib.mdDoc "git");
package = mkOption {
type = types.package;
@ -33,7 +33,7 @@ in
};
lfs = {
enable = mkEnableOption "git-lfs";
enable = mkEnableOption (lib.mdDoc "git-lfs");
package = mkOption {
type = types.package;

2
nixos/modules/programs/gnome-terminal.nix
View file

@ -24,7 +24,7 @@ in
];
options = {
programs.gnome-terminal.enable = mkEnableOption "GNOME Terminal";
programs.gnome-terminal.enable = mkEnableOption (lib.mdDoc "GNOME Terminal");
};
config = mkIf cfg.enable {

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

@ -4,7 +4,7 @@ with lib;
{
options.programs.haguichi = {
enable = mkEnableOption "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi";
enable = mkEnableOption (lib.mdDoc "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi");
};
config = mkIf config.programs.haguichi.enable {

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

@ -6,7 +6,7 @@ with lib;
meta.maintainers = pkgs.hamster.meta.maintainers;
options.programs.hamster.enable =
mkEnableOption "hamster, a time tracking program";
mkEnableOption (lib.mdDoc "hamster, a time tracking program");
config = lib.mkIf config.programs.hamster.enable {
environment.systemPackages = [ pkgs.hamster ];

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

@ -26,7 +26,7 @@ in
'';
};
enable = mkEnableOption "htop process monitor";
enable = mkEnableOption (lib.mdDoc "htop process monitor");
settings = mkOption {
type = with types; attrsOf (oneOf [ str int bool (listOf (oneOf [ str int bool ])) ]);

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

@ -6,7 +6,7 @@ let
cfg = config.programs.iftop;
in {
options = {
programs.iftop.enable = mkEnableOption "iftop + setcap wrapper";
programs.iftop.enable = mkEnableOption (lib.mdDoc "iftop + setcap wrapper");
};
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.iftop ];

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

@ -6,7 +6,7 @@ let
cfg = config.programs.iotop;
in {
options = {
programs.iotop.enable = mkEnableOption "iotop + setcap wrapper";
programs.iotop.enable = mkEnableOption (lib.mdDoc "iotop + setcap wrapper");
};
config = mkIf cfg.enable {
security.wrappers.iotop = {

2
nixos/modules/programs/k40-whisperer.nix
View file

@ -10,7 +10,7 @@ let
in
{
options.programs.k40-whisperer = {
enable = mkEnableOption "K40-Whisperer";
enable = mkEnableOption (lib.mdDoc "K40-Whisperer");
group = mkOption {
type = types.str;

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

@ -7,7 +7,7 @@ let
in
{
options.programs.kbdlight.enable = mkEnableOption "kbdlight";
options.programs.kbdlight.enable = mkEnableOption (lib.mdDoc "kbdlight");
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.kbdlight ];

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

@ -4,7 +4,7 @@ let
cfg = config.programs.kclock;
kclockPkg = pkgs.libsForQt5.kclock;
in {
options.programs.kclock = { enable = mkEnableOption "Enable KClock"; };
options.programs.kclock = { enable = mkEnableOption (lib.mdDoc "Enable KClock"); };
config = mkIf cfg.enable {
services.dbus.packages = [ kclockPkg ];

8
nixos/modules/programs/kdeconnect.nix
View file

@ -2,15 +2,15 @@
with lib;
{
options.programs.kdeconnect = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
kdeconnect.
Note that it will open the TCP and UDP port from
1714 to 1764 as they are needed for it to function properly.
You can use the <option>package</option> to use
<literal>gnomeExtensions.gsconnect</literal> as an alternative
You can use the {option}`package` to use
`gnomeExtensions.gsconnect` as an alternative
implementation if you use Gnome.
'';
'');
package = mkOption {
default = pkgs.plasma5Packages.kdeconnect-kde;
defaultText = literalExpression "pkgs.plasma5Packages.kdeconnect-kde";

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

@ -35,7 +35,7 @@ in
# note that environment.nix sets PAGER=less, and
# therefore also enables this module
enable = mkEnableOption "less";
enable = mkEnableOption (lib.mdDoc "less");
configFile = mkOption {
type = types.nullOr types.path;

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

@ -6,7 +6,7 @@ let
cfg = config.programs.liboping;
in {
options.programs.liboping = {
enable = mkEnableOption "liboping";
enable = mkEnableOption (lib.mdDoc "liboping");
};
config = mkIf cfg.enable {
environment.systemPackages = with pkgs; [ liboping ];

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

@ -28,7 +28,7 @@ let
'';
in
{
options.programs.mininet.enable = mkEnableOption "Mininet";
options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet");
config = mkIf cfg.enable {

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

@ -10,7 +10,7 @@ in {
options = {
programs.msmtp = {
enable = mkEnableOption "msmtp - an SMTP client";
enable = mkEnableOption (lib.mdDoc "msmtp - an SMTP client");
setSendmail = mkOption {
type = types.bool;

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

@ -8,7 +8,7 @@ in
{
options = {
programs.nbd = {
enable = mkEnableOption "Network Block Device (nbd) support";
enable = mkEnableOption (lib.mdDoc "Network Block Device (nbd) support");
};
};

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

@ -11,7 +11,7 @@ let
in {
options.programs.neovim = {
enable = mkEnableOption "Neovim";
enable = mkEnableOption (lib.mdDoc "Neovim");
defaultEditor = mkOption {
type = types.bool;

2
nixos/modules/programs/nix-ld.nix
View file

@ -2,7 +2,7 @@
{
meta.maintainers = [ lib.maintainers.mic92 ];
options = {
programs.nix-ld.enable = lib.mkEnableOption ''nix-ld, Documentation: <link xlink:href="https://github.com/Mic92/nix-ld"/>'';
programs.nix-ld.enable = lib.mkEnableOption (lib.mdDoc ''nix-ld, Documentation: <https://github.com/Mic92/nix-ld>'');
};
config = lib.mkIf config.programs.nix-ld.enable {
systemd.tmpfiles.packages = [ pkgs.nix-ld ];

2
nixos/modules/programs/nm-applet.nix
View file

@ -6,7 +6,7 @@
};
options.programs.nm-applet = {
enable = lib.mkEnableOption "nm-applet";
enable = lib.mkEnableOption (lib.mdDoc "nm-applet");
indicator = lib.mkOption {
type = lib.types.bool;

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

@ -11,7 +11,7 @@ in {
options.programs.nncp = {
enable =
mkEnableOption "NNCP (Node to Node copy) utilities and configuration";
mkEnableOption (lib.mdDoc "NNCP (Node to Node copy) utilities and configuration");
group = mkOption {
type = types.str;

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

@ -6,7 +6,7 @@ let cfg = config.programs.noisetorch;
in
{
options.programs.noisetorch = {
enable = mkEnableOption "noisetorch + setcap wrapper";
enable = mkEnableOption (lib.mdDoc "noisetorch + setcap wrapper");
package = mkOption {
type = types.package;

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

@ -11,7 +11,7 @@ in
options = {
programs.npm = {
enable = mkEnableOption "<command>npm</command> global config";
enable = mkEnableOption (lib.mdDoc "{command}`npm` global config");
package = mkOption {
type = types.package;

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

@ -7,7 +7,7 @@ let
in
{
options.programs.openvpn3 = {
enable = mkEnableOption "the openvpn3 client";
enable = mkEnableOption (lib.mdDoc "the openvpn3 client");
};
config = mkIf cfg.enable {

2
nixos/modules/programs/pantheon-tweaks.nix
View file

@ -9,7 +9,7 @@ with lib;
###### interface
options = {
programs.pantheon-tweaks.enable = mkEnableOption "Pantheon Tweaks, an unofficial system settings panel for Pantheon";
programs.pantheon-tweaks.enable = mkEnableOption (lib.mdDoc "Pantheon Tweaks, an unofficial system settings panel for Pantheon");
};
###### implementation

2
nixos/modules/programs/partition-manager.nix
View file

@ -7,7 +7,7 @@ with lib;
###### interface
options = {
programs.partition-manager.enable = mkEnableOption "KDE Partition Manager";
programs.partition-manager.enable = mkEnableOption (lib.mdDoc "KDE Partition Manager");
};
###### implementation

6
nixos/modules/programs/proxychains.nix
View file

@ -22,7 +22,7 @@ let
proxyOptions = {
options = {
enable = mkEnableOption "this proxy";
enable = mkEnableOption (lib.mdDoc "this proxy");
type = mkOption {
type = types.enum [ "http" "socks4" "socks5" ];
@ -49,7 +49,7 @@ in {
programs.proxychains = {
enable = mkEnableOption "installing proxychains configuration";
enable = mkEnableOption (lib.mdDoc "installing proxychains configuration");
chain = {
type = mkOption {
@ -86,7 +86,7 @@ in {
description = lib.mdDoc "Proxy DNS requests - no leak for DNS data.";
};
quietMode = mkEnableOption "Quiet mode (no output from the library).";
quietMode = mkEnableOption (lib.mdDoc "Quiet mode (no output from the library).");
remoteDNSSubnet = mkOption {
type = types.enum [ 10 127 224 ];

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

@ -20,7 +20,7 @@ with lib;
programs.seahorse = {
enable = mkEnableOption "Seahorse, a GNOME application for managing encryption keys and passwords in the GNOME Keyring";
enable = mkEnableOption (lib.mdDoc "Seahorse, a GNOME application for managing encryption keys and passwords in the GNOME Keyring");
};

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

@ -6,7 +6,7 @@ let
cfg = config.programs.sedutil;
in {
options.programs.sedutil.enable = mkEnableOption "sedutil";
options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil");
config = mkIf cfg.enable {
boot.kernelParams = [

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

@ -11,7 +11,7 @@ let
});
in {
options.programs.singularity = {
enable = mkEnableOption "Singularity";
enable = mkEnableOption (lib.mdDoc "Singularity");
};
config = mkIf cfg.enable {

Some files were not shown because too many files have changed in this diff Show more