swendel/nixpkgs
1
0
Fork 0
mirror of https://github.com/SebastianWendel/nixpkgs.git synced 2024-09-20 04:19:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

nixos/*: convert internal option descriptions to MD

Browse source 
we'll have to do it eventually, may as well be now.
This commit is contained in:
pennae 2022-08-29 01:38:36 +02:00
parent ef176dcf7e
commit 9547123258
60 changed files with 116 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -94,7 +94,7 @@ in rec {
unit = mkOption { unit = mkOption {
internal = true; internal = true;
description = "The generated unit."; description = lib.mdDoc "The generated unit.";
}; };
}; };
@ -358,7 +358,7 @@ in rec {
jobScripts = mkOption { jobScripts = mkOption {
type = with types; coercedTo path singleton (listOf path); type = with types; coercedTo path singleton (listOf path);
internal = true; internal = true;
description = "A list of all job script derivations of this unit."; description = lib.mdDoc "A list of all job script derivations of this unit.";
default = []; default = [];
}; };

2
nixos/modules/config/fonts/fontconfig.nix
View file

@ -259,7 +259,7 @@ in
internal = true; internal = true;
type = with types; listOf path; type = with types; listOf path;
default = [ ]; default = [ ];
description = '' description = lib.mdDoc ''
Fontconfig configuration packages. Fontconfig configuration packages.
''; '';
}; };

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

@ -141,7 +141,7 @@ in
type = types.attrs; type = types.attrs;
internal = true; internal = true;
default = {}; default = {};
description = '' description = lib.mdDoc ''
Environment variables used for the network proxy. Environment variables used for the network proxy.
''; '';
}; };

4
nixos/modules/config/shells-environment.nix
View file

@ -140,9 +140,9 @@ in
example = literalExpression ''"''${pkgs.dash}/bin/dash"''; example = literalExpression ''"''${pkgs.dash}/bin/dash"'';
type = types.path; type = types.path;
visible = false; visible = false;
description = '' description = lib.mdDoc ''
The shell executable that is linked system-wide to The shell executable that is linked system-wide to
<literal>/bin/sh</literal>. Please note that NixOS assumes all `/bin/sh`. Please note that NixOS assumes all
over the place that shell to be Bash, so override the default over the place that shell to be Bash, so override the default
setting only if you know exactly what you're doing. setting only if you know exactly what you're doing.
''; '';

2
nixos/modules/config/system-path.nix
View file

@ -132,7 +132,7 @@ in
path = mkOption { path = mkOption {
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The packages you want in the boot environment. The packages you want in the boot environment.
''; '';
}; };

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

@ -54,11 +54,11 @@ in
type = types.bool; type = types.bool;
visible = false; visible = false;
default = false; default = false;
description = '' description = lib.mdDoc ''
Sets environment variable <literal>GTK_USE_PORTAL</literal> to <literal>1</literal>. Sets environment variable `GTK_USE_PORTAL` to `1`.
This will force GTK-based programs ran outside Flatpak to respect and use XDG Desktop Portals This will force GTK-based programs ran outside Flatpak to respect and use XDG Desktop Portals
for features like file chooser but it is an unsupported hack that can easily break things. for features like file chooser but it is an unsupported hack that can easily break things.
Defaults to <literal>false</literal> to respect its opt-in nature. Defaults to `false` to respect its opt-in nature.
''; '';
}; };
}; };

2
nixos/modules/hardware/device-tree.nix
View file

@ -171,7 +171,7 @@ in
default = null; default = null;
type = types.nullOr types.path; type = types.nullOr types.path;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
A path containing the result of applying `overlays` to `kernelPackage`. A path containing the result of applying `overlays` to `kernelPackage`.
''; '';
}; };

12
nixos/modules/hardware/opengl.nix
View file

@ -71,7 +71,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The package that provides the OpenGL implementation. The package that provides the OpenGL implementation.
''; '';
}; };
@ -79,9 +79,9 @@ in
package32 = mkOption { package32 = mkOption {
type = types.package; type = types.package;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The package that provides the 32-bit OpenGL implementation on The package that provides the 32-bit OpenGL implementation on
64-bit systems. Used when <option>driSupport32Bit</option> is 64-bit systems. Used when {option}`driSupport32Bit` is
set. set.
''; '';
}; };
@ -111,11 +111,11 @@ in
type = types.bool; type = types.bool;
internal = true; internal = true;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether the <literal>LD_LIBRARY_PATH</literal> environment variable Whether the `LD_LIBRARY_PATH` environment variable
should be set to the locations of driver libraries. Drivers which should be set to the locations of driver libraries. Drivers which
rely on overriding libraries should set this to true. Drivers which rely on overriding libraries should set this to true. Drivers which
support <literal>libglvnd</literal> and other dispatch libraries support `libglvnd` and other dispatch libraries
instead of overriding libraries should not set this. instead of overriding libraries should not set this.
''; '';
}; };

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

@ -53,7 +53,7 @@ in
internal = true; internal = true;
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
description = '' description = lib.mdDoc ''
The input method method package. The input method method package.
''; '';
}; };

4
nixos/modules/misc/assertions.nix
View file

@ -11,7 +11,7 @@ with lib;
internal = true; internal = true;
default = []; default = [];
example = [ { assertion = false; message = "you can't enable this for that reason"; } ]; example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
description = '' description = lib.mdDoc ''
This option allows modules to express conditions that must This option allows modules to express conditions that must
hold for the evaluation of the system configuration to hold for the evaluation of the system configuration to
succeed, along with associated error messages for the user. succeed, along with associated error messages for the user.
@ -23,7 +23,7 @@ with lib;
default = []; default = [];
type = types.listOf types.str; type = types.listOf types.str;
example = [ "The `foo' service is deprecated and will go away soon!" ]; example = [ "The `foo' service is deprecated and will go away soon!" ];
description = '' description = lib.mdDoc ''
This option allows modules to show warnings to users during This option allows modules to show warnings to users during
the evaluation of the system configuration. the evaluation of the system configuration.
''; '';

4
nixos/modules/misc/ids.nix
View file

@ -19,7 +19,7 @@ in
ids.uids = lib.mkOption { ids.uids = lib.mkOption {
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The user IDs used in NixOS. The user IDs used in NixOS.
''; '';
type = types.attrsOf types.int; type = types.attrsOf types.int;
@ -27,7 +27,7 @@ in
ids.gids = lib.mkOption { ids.gids = lib.mkOption {
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The group IDs used in NixOS. The group IDs used in NixOS.
''; '';
type = types.attrsOf types.int; type = types.attrsOf types.int;

6
nixos/modules/misc/meta.nix
View file

@ -38,7 +38,7 @@ in
internal = true; internal = true;
default = []; default = [];
example = literalExpression ''[ lib.maintainers.all ]''; example = literalExpression ''[ lib.maintainers.all ]'';
description = '' description = lib.mdDoc ''
List of maintainers of each module. This option should be defined at List of maintainers of each module. This option should be defined at
most once per module. most once per module.
''; '';
@ -48,7 +48,7 @@ in
type = docFile; type = docFile;
internal = true; internal = true;
example = "./meta.chapter.xml"; example = "./meta.chapter.xml";
description = '' description = lib.mdDoc ''
Documentation prologue for the set of options of each module. This Documentation prologue for the set of options of each module. This
option should be defined at most once per module. option should be defined at most once per module.
''; '';
@ -60,7 +60,7 @@ in
}; };
internal = true; internal = true;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether to include this module in the split options doc build. Whether to include this module in the split options doc build.
Disable if the module references `config`, `pkgs` or other module Disable if the module references `config`, `pkgs` or other module
arguments that cannot be evaluated as constants. arguments that cannot be evaluated as constants.

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

@ -7,7 +7,7 @@
options = { options = {
passthru = lib.mkOption { passthru = lib.mkOption {
visible = false; visible = false;
description = '' description = lib.mdDoc ''
This attribute set will be exported as a system attribute. This attribute set will be exported as a system attribute.
You can put whatever you want here. You can put whatever you want here.
''; '';

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

@ -89,7 +89,7 @@ in {
type = types.package; type = types.package;
visible = false; visible = false;
readOnly = true; readOnly = true;
description = "Resulting customized neovim package."; description = lib.mdDoc "Resulting customized neovim package.";
}; };
runtime = mkOption { runtime = mkOption {

2
nixos/modules/programs/tsm-client.nix
View file

@ -140,7 +140,7 @@ let
type = str; type = str;
internal = true; internal = true;
visible = false; visible = false;
description = "Server stanza text generated from the options."; description = lib.mdDoc "Server stanza text generated from the options.";
}; };
config.name = mkDefault name; config.name = mkDefault name;
# Client system-options file directives are explained here: # Client system-options file directives are explained here:

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

@ -199,7 +199,7 @@ in
type = lib.types.path; type = lib.types.path;
default = "/run/wrappers/bin"; default = "/run/wrappers/bin";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
This option defines the path to the wrapper programs. It This option defines the path to the wrapper programs. It
should not be overriden. should not be overriden.
''; '';

2
nixos/modules/services/audio/jack.nix
View file

@ -27,7 +27,7 @@ in {
default = pkgs.jack2; default = pkgs.jack2;
defaultText = literalExpression "pkgs.jack2"; defaultText = literalExpression "pkgs.jack2";
example = literalExpression "pkgs.jack1"; example = literalExpression "pkgs.jack1";
description = '' description = lib.mdDoc ''
The JACK package to use. The JACK package to use.
''; '';
}; };

6
nixos/modules/services/cluster/hadoop/default.nix
View file

@ -25,7 +25,7 @@ with lib;
default = {}; default = {};
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Internal option to add configs to core-site.xml based on module options Internal option to add configs to core-site.xml based on module options
''; '';
}; };
@ -59,7 +59,7 @@ with lib;
default = {}; default = {};
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Internal option to add configs to hdfs-site.xml based on module options Internal option to add configs to hdfs-site.xml based on module options
''; '';
}; };
@ -134,7 +134,7 @@ with lib;
default = {}; default = {};
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Internal option to add configs to yarn-site.xml based on module options Internal option to add configs to yarn-site.xml based on module options
''; '';
}; };

2
nixos/modules/services/cluster/hadoop/hbase.nix
View file

@ -39,7 +39,7 @@ in
default = {}; default = {};
type = with types; attrsOf anything; type = with types; attrsOf anything;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Internal option to add configs to hbase-site.xml based on module options Internal option to add configs to hbase-site.xml based on module options
''; '';
}; };

2
nixos/modules/services/computing/slurm/slurm.nix
View file

@ -285,7 +285,7 @@ in
Directory created from generated config files and Directory created from generated config files and
`config.${opt.extraConfigPaths}`. `config.${opt.extraConfigPaths}`.
''; '';
description = '' description = lib.mdDoc ''
Path to directory with slurm config files. This option is set by default from the Path to directory with slurm config files. This option is set by default from the
Slurm module and is meant to make the Slurm config file available to other modules. Slurm module and is meant to make the Slurm config file available to other modules.
''; '';

2
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
View file

@ -236,7 +236,7 @@ in
type = types.path; type = types.path;
internal = true; internal = true;
defaultText = literalMD "generated `hercules-ci-agent.toml`"; defaultText = literalMD "generated `hercules-ci-agent.toml`";
description = '' description = lib.mdDoc ''
The fully assembled config file. The fully assembled config file.
''; '';
}; };

2
nixos/modules/services/databases/neo4j.nix
View file

@ -538,7 +538,7 @@ in {
type = types.listOf types.path; type = types.listOf types.path;
internal = true; internal = true;
readOnly = true; readOnly = true;
description = '' description = lib.mdDoc ''
Directories of this policy that will be created automatically Directories of this policy that will be created automatically
when the certificates directory is left at its default value. when the certificates directory is left at its default value.
This includes all options of type path that are left at their This includes all options of type path that are left at their

2
nixos/modules/services/databases/postgresql.nix
View file

@ -264,7 +264,7 @@ in
default = "postgres"; default = "postgres";
internal = true; internal = true;
readOnly = true; readOnly = true;
description = '' description = lib.mdDoc ''
PostgreSQL superuser account to use for various operations. Internal since changing PostgreSQL superuser account to use for various operations. Internal since changing
this value would lead to breakage while setting up databases. this value would lead to breakage while setting up databases.
''; '';

2
nixos/modules/services/desktops/gnome/tracker.nix
View file

@ -40,7 +40,7 @@ in
type = types.listOf types.package; type = types.listOf types.package;
default = [ ]; default = [ ];
internal = true; internal = true;
description = '' description = lib.mdDoc ''
List of packages containing tracker3 subcommands. List of packages containing tracker3 subcommands.
''; '';
}; };

2
nixos/modules/services/hardware/sane.nix
View file

@ -89,7 +89,7 @@ in
hardware.sane.configDir = mkOption { hardware.sane.configDir = mkOption {
type = types.str; type = types.str;
internal = true; internal = true;
description = "The value of SANE_CONFIG_DIR."; description = lib.mdDoc "The value of SANE_CONFIG_DIR.";
}; };
hardware.sane.netConf = mkOption { hardware.sane.netConf = mkOption {

14
nixos/modules/services/hardware/udev.nix
View file

@ -300,13 +300,13 @@ in
type = types.listOf types.path; type = types.listOf types.path;
default = []; default = [];
visible = false; visible = false;
description = '' description = lib.mdDoc ''
<emphasis>This will only be used when systemd is used in stage 1.</emphasis> *This will only be used when systemd is used in stage 1.*
List of packages containing <command>udev</command> rules that will be copied to stage 1. List of packages containing {command}`udev` rules that will be copied to stage 1.
All files found in All files found in
<filename>«pkg»/etc/udev/rules.d</filename> and {file}`«pkg»/etc/udev/rules.d` and
<filename>«pkg»/lib/udev/rules.d</filename> {file}`«pkg»/lib/udev/rules.d`
will be included. will be included.
''; '';
}; };
@ -315,8 +315,8 @@ in
type = types.listOf types.path; type = types.listOf types.path;
default = []; default = [];
visible = false; visible = false;
description = '' description = lib.mdDoc ''
<emphasis>This will only be used when systemd is used in stage 1.</emphasis> *This will only be used when systemd is used in stage 1.*
Packages to search for binaries that are referenced by the udev rules in stage 1. Packages to search for binaries that are referenced by the udev rules in stage 1.
This list always contains /bin of the initrd. This list always contains /bin of the initrd.

12
nixos/modules/services/logging/filebeat.nix
View file

@ -159,27 +159,27 @@ in
type = types.listOf json.type; type = types.listOf json.type;
default = []; default = [];
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Inputs specify how Filebeat locates and processes Inputs specify how Filebeat locates and processes
input data. Use <xref linkend="opt-services.filebeat.inputs"/> instead. input data. Use [](#opt-services.filebeat.inputs) instead.
See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>. See <https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html>.
''; '';
}; };
modules = mkOption { modules = mkOption {
type = types.listOf json.type; type = types.listOf json.type;
default = []; default = [];
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Filebeat modules provide a quick way to get started Filebeat modules provide a quick way to get started
processing common log formats. They contain default processing common log formats. They contain default
configurations, Elasticsearch ingest pipeline configurations, Elasticsearch ingest pipeline
definitions, and Kibana dashboards to help you definitions, and Kibana dashboards to help you
implement and deploy a log monitoring solution. implement and deploy a log monitoring solution.
Use <xref linkend="opt-services.filebeat.modules"/> instead. Use [](#opt-services.filebeat.modules) instead.
See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html"/>. See <https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html>.
''; '';
}; };
}; };

2
nixos/modules/services/mail/mail.nix
View file

@ -14,7 +14,7 @@ with lib;
type = types.nullOr options.security.wrappers.type.nestedTypes.elemType; type = types.nullOr options.security.wrappers.type.nestedTypes.elemType;
default = null; default = null;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Configuration for the sendmail setuid wapper. Configuration for the sendmail setuid wapper.
''; '';
}; };

4
nixos/modules/services/mail/postfix.nix
View file

@ -140,8 +140,8 @@ let
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The raw configuration line for the <filename>master.cf</filename>. The raw configuration line for the {file}`master.cf`.
''; '';
}; };
}; };

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

@ -340,7 +340,7 @@ in
type = types.attrs; type = types.attrs;
internal = true; internal = true;
default = { }; default = { };
description = "Environment variables used by Nix."; description = lib.mdDoc "Environment variables used by Nix.";
}; };
nrBuildUsers = mkOption { nrBuildUsers = mkOption {

2
nixos/modules/services/misc/sourcehut/default.nix
View file

@ -132,7 +132,7 @@ in
internal = true; internal = true;
type = types.package; type = types.package;
default = python; default = python;
description = '' description = lib.mdDoc ''
The python package to use. It should contain references to the *srht modules and also The python package to use. It should contain references to the *srht modules and also
gunicorn. gunicorn.
''; '';

6
nixos/modules/services/monitoring/metricbeat.nix
View file

@ -99,10 +99,10 @@ in
type = types.listOf settingsFormat.type; type = types.listOf settingsFormat.type;
default = []; default = [];
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The metric collecting modules. Use <xref linkend="opt-services.metricbeat.modules"/> instead. The metric collecting modules. Use [](#opt-services.metricbeat.modules) instead.
See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. See <https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html>.
''; '';
}; };
}; };

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

@ -139,7 +139,7 @@ in
services.nylon = mkOption { services.nylon = mkOption {
default = {}; default = {};
description = "Collection of named nylon instances"; description = lib.mdDoc "Collection of named nylon instances";
type = with types; attrsOf (submodule nylonOpts); type = with types; attrsOf (submodule nylonOpts);
internal = true; internal = true;
}; };

2
nixos/modules/services/printing/cupsd.nix
View file

@ -167,7 +167,7 @@ in
type = types.lines; type = types.lines;
internal = true; internal = true;
default = ""; default = "";
description = '' description = lib.mdDoc ''
Additional commands executed while creating the directory Additional commands executed while creating the directory
containing the CUPS server binaries. containing the CUPS server binaries.
''; '';

4
nixos/modules/services/system/dbus.nix
View file

@ -29,7 +29,7 @@ in
type = types.bool; type = types.bool;
default = false; default = false;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether to start the D-Bus message bus daemon, which is Whether to start the D-Bus message bus daemon, which is
required by many other system services and applications. required by many other system services and applications.
''; '';
@ -70,7 +70,7 @@ in
type = types.nullOr types.bool; type = types.nullOr types.bool;
default = null; default = null;
visible = false; visible = false;
description = '' description = lib.mdDoc ''
Removed option, do not use. Removed option, do not use.
''; '';
}; };

4
nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix
View file

@ -66,7 +66,7 @@ in {
visible = false; visible = false;
default = name; default = name;
type = str; type = str;
description = "Name of this backend"; description = lib.mdDoc "Name of this backend";
}; };
resource = mkOption { resource = mkOption {
@ -98,7 +98,7 @@ in {
visible = false; visible = false;
default = name; default = name;
type = str; type = str;
description = "Name of this transport"; description = lib.mdDoc "Name of this transport";
}; };
type = mkOption { type = mkOption {

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

@ -529,7 +529,7 @@ in {
default = occ; default = occ;
defaultText = literalMD "generated script"; defaultText = literalMD "generated script";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The nextcloud-occ program preconfigured to target this Nextcloud instance. The nextcloud-occ program preconfigured to target this Nextcloud instance.
''; '';
}; };

4
nixos/modules/services/x11/desktop-managers/default.nix
View file

@ -64,10 +64,10 @@ in
bgSupport = true; bgSupport = true;
start = "..."; start = "...";
}; };
description = '' description = lib.mdDoc ''
Internal option used to add some common line to desktop manager Internal option used to add some common line to desktop manager
scripts before forwarding the value to the scripts before forwarding the value to the
<varname>displayManager</varname>. `displayManager`.
''; '';
apply = map (d: d // { apply = map (d: d // {
manage = "desktop"; manage = "desktop";

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

@ -201,7 +201,7 @@ in
favorite-apps=[ 'firefox.desktop', 'org.gnome.Calendar.desktop' ] favorite-apps=[ 'firefox.desktop', 'org.gnome.Calendar.desktop' ]
''' '''
''; '';
description = "List of desktop files to put as favorite apps into gnome-shell. These need to be installed somehow globally."; description = lib.mdDoc "List of desktop files to put as favorite apps into gnome-shell. These need to be installed somehow globally.";
}; };
extraGSettingsOverrides = mkOption { extraGSettingsOverrides = mkOption {

6
nixos/modules/services/x11/display-managers/default.nix
View file

@ -153,7 +153,7 @@ in
internal = true; internal = true;
default = "${xorg.xauth}/bin/xauth"; default = "${xorg.xauth}/bin/xauth";
defaultText = literalExpression ''"''${pkgs.xorg.xauth}/bin/xauth"''; defaultText = literalExpression ''"''${pkgs.xorg.xauth}/bin/xauth"'';
description = "Path to the <command>xauth</command> program used by display managers."; description = lib.mdDoc "Path to the {command}`xauth` program used by display managers.";
}; };
xserverBin = mkOption { xserverBin = mkOption {
@ -252,7 +252,7 @@ in
}; };
sessionData = mkOption { sessionData = mkOption {
description = "Data exported for display managers’ convenience"; description = lib.mdDoc "Data exported for display managers’ convenience";
internal = true; internal = true;
default = {}; default = {};
apply = val: { apply = val: {
@ -299,7 +299,7 @@ in
importedVariables = mkOption { importedVariables = mkOption {
type = types.listOf (types.strMatching "[a-zA-Z_][a-zA-Z0-9_]*"); type = types.listOf (types.strMatching "[a-zA-Z_][a-zA-Z0-9_]*");
visible = false; visible = false;
description = '' description = lib.mdDoc ''
Environment variables to import into the systemd user environment. Environment variables to import into the systemd user environment.
''; '';
}; };

4
nixos/modules/services/x11/window-managers/default.nix
View file

@ -59,10 +59,10 @@ in
name = "wmii"; name = "wmii";
start = "..."; start = "...";
}]; }];
description = '' description = lib.mdDoc ''
Internal option used to add some common line to window manager Internal option used to add some common line to window manager
scripts before forwarding the value to the scripts before forwarding the value to the
<varname>displayManager</varname>. `displayManager`.
''; '';
apply = map (d: d // { apply = map (d: d // {
manage = "window"; manage = "window";

2
nixos/modules/services/x11/xserver.nix
View file

@ -294,7 +294,7 @@ in
drivers = mkOption { drivers = mkOption {
type = types.listOf types.attrs; type = types.listOf types.attrs;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
A list of attribute sets specifying drivers to be loaded by A list of attribute sets specifying drivers to be loaded by
the X11 server. the X11 server.
''; '';

6
nixos/modules/system/activation/activation-script.nix
View file

@ -139,7 +139,7 @@ in
}; };
system.dryActivationScript = mkOption { system.dryActivationScript = mkOption {
description = "The shell script that is to be run when dry-activating a system."; description = lib.mdDoc "The shell script that is to be run when dry-activating a system.";
readOnly = true; readOnly = true;
internal = true; internal = true;
default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true; default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true;
@ -199,9 +199,9 @@ in
example = literalExpression ''"''${pkgs.busybox}/bin/env"''; example = literalExpression ''"''${pkgs.busybox}/bin/env"'';
type = types.nullOr types.path; type = types.nullOr types.path;
visible = false; visible = false;
description = '' description = lib.mdDoc ''
The env(1) executable that is linked system-wide to The env(1) executable that is linked system-wide to
<literal>/usr/bin/env</literal>. `/usr/bin/env`.
''; '';
}; };
}; };

12
nixos/modules/system/activation/top-level.nix
View file

@ -207,7 +207,7 @@ in
system.boot.loader.id = mkOption { system.boot.loader.id = mkOption {
internal = true; internal = true;
default = ""; default = "";
description = '' description = lib.mdDoc ''
Id string of the used bootloader. Id string of the used bootloader.
''; '';
}; };
@ -217,7 +217,7 @@ in
default = pkgs.stdenv.hostPlatform.linux-kernel.target; default = pkgs.stdenv.hostPlatform.linux-kernel.target;
defaultText = literalExpression "pkgs.stdenv.hostPlatform.linux-kernel.target"; defaultText = literalExpression "pkgs.stdenv.hostPlatform.linux-kernel.target";
type = types.str; type = types.str;
description = '' description = lib.mdDoc ''
Name of the kernel file to be passed to the bootloader. Name of the kernel file to be passed to the bootloader.
''; '';
}; };
@ -226,7 +226,7 @@ in
internal = true; internal = true;
default = "initrd"; default = "initrd";
type = types.str; type = types.str;
description = '' description = lib.mdDoc ''
Name of the initrd file to be passed to the bootloader. Name of the initrd file to be passed to the bootloader.
''; '';
}; };
@ -238,10 +238,10 @@ in
# go to `true` instead of `echo`, hiding the useless path # go to `true` instead of `echo`, hiding the useless path
# from the log. # from the log.
default = "echo 'Warning: do not know how to make this configuration bootable; please enable a boot loader.' 1>&2; true"; default = "echo 'Warning: do not know how to make this configuration bootable; please enable a boot loader.' 1>&2; true";
description = '' description = lib.mdDoc ''
A program that writes a bootloader installation script to the path passed in the first command line argument. A program that writes a bootloader installation script to the path passed in the first command line argument.
See <literal>nixos/modules/system/activation/switch-to-configuration.pl</literal>. See `nixos/modules/system/activation/switch-to-configuration.pl`.
''; '';
type = types.unique { type = types.unique {
message = '' message = ''
@ -280,7 +280,7 @@ in
type = types.lines; type = types.lines;
internal = true; internal = true;
default = ""; default = "";
description = '' description = lib.mdDoc ''
This code will be added to the builder creating the system store path. This code will be added to the builder creating the system store path.
''; '';
}; };

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

@ -256,7 +256,7 @@ in {
interpreterSandboxPath = mkOption { interpreterSandboxPath = mkOption {
internal = true; internal = true;
default = null; default = null;
description = '' description = lib.mdDoc ''
Path of the interpreter to expose in the build sandbox. Path of the interpreter to expose in the build sandbox.
''; '';
type = types.nullOr types.path; type = types.nullOr types.path;

6
nixos/modules/system/boot/kernel.nix
View file

@ -25,7 +25,7 @@ in
default = {}; default = {};
example = literalExpression "{ debug = true; }"; example = literalExpression "{ debug = true; }";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
This option allows to enable or disable certain kernel features. This option allows to enable or disable certain kernel features.
It's not API, because it's about kernel feature sets, that It's not API, because it's about kernel feature sets, that
make sense for specific use cases. Mostly along with programs, make sense for specific use cases. Mostly along with programs,
@ -173,7 +173,7 @@ in
type = types.listOf types.path; type = types.listOf types.path;
internal = true; internal = true;
default = []; default = [];
description = '' description = lib.mdDoc ''
Tree of kernel modules. This includes the kernel, plus modules Tree of kernel modules. This includes the kernel, plus modules
built outside of the kernel. Combine these into a single tree of built outside of the kernel. Combine these into a single tree of
symlinks because modprobe only supports one directory. symlinks because modprobe only supports one directory.
@ -193,7 +193,7 @@ in
''; '';
internal = true; internal = true;
type = types.listOf types.attrs; type = types.listOf types.attrs;
description = '' description = lib.mdDoc ''
This option allows modules to specify the kernel config options that This option allows modules to specify the kernel config options that
must be set (or unset) for the module to work. Please use the must be set (or unset) for the module to work. Please use the
lib.kernelConfig functions to build list elements. lib.kernelConfig functions to build list elements.

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

@ -14,7 +14,7 @@ let
default = null; default = null;
internal = true; internal = true;
visible = true; visible = true;
description = '' description = lib.mdDoc ''
Use this field for tristate kernel options expecting a "y" or "m" or "n". Use this field for tristate kernel options expecting a "y" or "m" or "n".
''; '';
}; };

6
nixos/modules/system/boot/luksroot.nix
View file

@ -523,7 +523,7 @@ in
type = types.bool; type = types.bool;
default = false; default = false;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether to configure luks support in the initrd, when no luks Whether to configure luks support in the initrd, when no luks
devices are configured. devices are configured.
''; '';
@ -563,7 +563,7 @@ in
default = name; default = name;
example = "luksroot"; example = "luksroot";
type = types.str; type = types.str;
description = "Name of the unencrypted device in <filename>/dev/mapper</filename>."; description = lib.mdDoc "Name of the unencrypted device in {file}`/dev/mapper`.";
}; };
device = mkOption { device = mkOption {
@ -819,7 +819,7 @@ in
default = []; default = [];
example = [ "_netdev" ]; example = [ "_netdev" ];
visible = false; visible = false;
description = '' description = lib.mdDoc ''
Only used with systemd stage 1. Only used with systemd stage 1.
Extra options to append to the last column of the generated crypttab file. Extra options to append to the last column of the generated crypttab file.

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

@ -1824,7 +1824,7 @@ in
}; };
systemd.network.units = mkOption { systemd.network.units = mkOption {
description = "Definition of networkd units."; description = lib.mdDoc "Definition of networkd units.";
default = {}; default = {};
internal = true; internal = true;
type = with types; attrsOf (submodule ( type = with types; attrsOf (submodule (

8
nixos/modules/system/boot/stage-1.nix
View file

@ -575,7 +575,7 @@ in
internal = true; internal = true;
default = ""; default = "";
type = types.lines; type = types.lines;
description = '' description = lib.mdDoc ''
Shell commands to be executed in the builder of the Shell commands to be executed in the builder of the
extra-utils derivation. This can be used to provide extra-utils derivation. This can be used to provide
additional utilities in the initial ramdisk. additional utilities in the initial ramdisk.
@ -586,7 +586,7 @@ in
internal = true; internal = true;
default = ""; default = "";
type = types.lines; type = types.lines;
description = '' description = lib.mdDoc ''
Shell commands to be executed in the builder of the Shell commands to be executed in the builder of the
extra-utils derivation after patchelf has done its extra-utils derivation after patchelf has done its
job. This can be used to test additional utilities job. This can be used to test additional utilities
@ -598,7 +598,7 @@ in
internal = true; internal = true;
default = ""; default = "";
type = types.lines; type = types.lines;
description = '' description = lib.mdDoc ''
Shell commands to be executed in the builder of the Shell commands to be executed in the builder of the
udev-rules derivation. This can be used to add udev-rules derivation. This can be used to add
additional udev rules in the initial ramdisk. additional udev rules in the initial ramdisk.
@ -676,7 +676,7 @@ in
default = false; default = false;
type = types.bool; type = types.bool;
description = description =
'' lib.mdDoc ''
Whether the bootloader setup runs append-initrd-secrets. Whether the bootloader setup runs append-initrd-secrets.
If not, any needed secrets must be copied into the initrd If not, any needed secrets must be copied into the initrd
and thus added to the store. and thus added to the store.

2
nixos/modules/system/boot/systemd/user.nix
View file

@ -97,7 +97,7 @@ in {
default = []; default = [];
type = types.listOf types.str; type = types.listOf types.str;
example = []; example = [];
description = '' description = lib.mdDoc ''
Additional units shipped with systemd that should be enabled for per-user systemd instances. Additional units shipped with systemd that should be enabled for per-user systemd instances.
''; '';
internal = true; internal = true;

4
nixos/modules/tasks/filesystems.nix
View file

@ -223,7 +223,7 @@ in
system.fsPackages = mkOption { system.fsPackages = mkOption {
internal = true; internal = true;
default = [ ]; default = [ ];
description = "Packages supplying file system mounters and checkers."; description = lib.mdDoc "Packages supplying file system mounters and checkers.";
}; };
boot.supportedFilesystems = mkOption { boot.supportedFilesystems = mkOption {
@ -237,7 +237,7 @@ in
default = {}; default = {};
type = types.attrsOf (types.submodule coreFileSystemOpts); type = types.attrsOf (types.submodule coreFileSystemOpts);
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Special filesystems that are mounted very early during boot. Special filesystems that are mounted very early during boot.
''; '';
}; };

2
nixos/modules/tasks/lvm.nix
View file

@ -10,7 +10,7 @@ in {
default = pkgs.lvm2; default = pkgs.lvm2;
internal = true; internal = true;
defaultText = literalExpression "pkgs.lvm2"; defaultText = literalExpression "pkgs.lvm2";
description = '' description = lib.mdDoc ''
This option allows you to override the LVM package that's used on the system This option allows you to override the LVM package that's used on the system
(udev rules, tmpfiles, systemd services). (udev rules, tmpfiles, systemd services).
Defaults to pkgs.lvm2, pkgs.lvm2_dmeventd if dmeventd or pkgs.lvm2_vdo if vdo is enabled. Defaults to pkgs.lvm2, pkgs.lvm2_dmeventd if dmeventd or pkgs.lvm2_vdo if vdo is enabled.

2
nixos/modules/testing/service-runner.nix
View file

@ -107,7 +107,7 @@ let
opts = { config, name, ... }: { opts = { config, name, ... }: {
options.runner = mkOption { options.runner = mkOption {
internal = true; internal = true;
description = '' description = lib.mdDoc ''
A script that runs the service outside of systemd, A script that runs the service outside of systemd,
useful for testing or for using NixOS services outside useful for testing or for using NixOS services outside
of NixOS. of NixOS.

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

@ -8,7 +8,7 @@ in {
enable = lib.mkOption { enable = lib.mkOption {
default = false; default = false;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether the EC2 instance uses a ZFS root. Whether the EC2 instance uses a ZFS root.
''; '';
}; };
@ -44,7 +44,7 @@ in {
hvm = lib.mkOption { hvm = lib.mkOption {
default = lib.versionAtLeast config.system.stateVersion "17.03"; default = lib.versionAtLeast config.system.stateVersion "17.03";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether the EC2 instance is a HVM instance. Whether the EC2 instance is a HVM instance.
''; '';
}; };
@ -52,7 +52,7 @@ in {
default = pkgs.stdenv.hostPlatform.isAarch64; default = pkgs.stdenv.hostPlatform.isAarch64;
defaultText = literalExpression "pkgs.stdenv.hostPlatform.isAarch64"; defaultText = literalExpression "pkgs.stdenv.hostPlatform.isAarch64";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether the EC2 instance is using EFI. Whether the EC2 instance is using EFI.
''; '';
}; };

4
nixos/modules/virtualisation/cri-o.nix
View file

@ -72,7 +72,7 @@ in
type = types.package; type = types.package;
default = crioPackage; default = crioPackage;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The final CRI-O package (including extra packages). The final CRI-O package (including extra packages).
''; '';
}; };
@ -80,7 +80,7 @@ in
networkDir = mkOption { networkDir = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
description = "Override the network_dir option."; description = lib.mdDoc "Override the network_dir option.";
internal = true; internal = true;
}; };

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

@ -9,7 +9,7 @@ in
enable = lib.mkOption { enable = lib.mkOption {
default = false; default = false;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether the OpenStack instance uses a ZFS root. Whether the OpenStack instance uses a ZFS root.
''; '';
}; };
@ -47,7 +47,7 @@ in
default = pkgs.stdenv.hostPlatform.isAarch64; default = pkgs.stdenv.hostPlatform.isAarch64;
defaultText = literalExpression "pkgs.stdenv.hostPlatform.isAarch64"; defaultText = literalExpression "pkgs.stdenv.hostPlatform.isAarch64";
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether the instance is using EFI. Whether the instance is using EFI.
''; '';
}; };

2
nixos/modules/virtualisation/podman/default.nix
View file

@ -114,7 +114,7 @@ in
type = types.package; type = types.package;
default = podmanPackage; default = podmanPackage;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
The final Podman package (including extra packages). The final Podman package (including extra packages).
''; '';
}; };

2
nixos/modules/virtualisation/qemu-vm.nix
View file

@ -570,7 +570,7 @@ in
type = types.str; type = types.str;
default = ""; default = "";
internal = true; internal = true;
description = "Primary IP address used in /etc/hosts."; description = lib.mdDoc "Primary IP address used in /etc/hosts.";
}; };
virtualisation.qemu = { virtualisation.qemu = {

6
nixos/tests/common/resolver.nix
View file

@ -10,15 +10,15 @@
type = lib.types.bool; type = lib.types.bool;
default = true; default = true;
internal = true; internal = true;
description = '' description = lib.mdDoc ''
Whether to enable the resolver that automatically discovers zone in the Whether to enable the resolver that automatically discovers zone in the
test network. test network.
This option is <literal>true</literal> by default, because the module This option is `true` by default, because the module
defining this option needs to be explicitly imported. defining this option needs to be explicitly imported.
The reason this option exists is for the The reason this option exists is for the
<filename>nixos/tests/common/acme/server</filename> module, which {file}`nixos/tests/common/acme/server` module, which
needs that option to disable the resolver once the user has set its own needs that option to disable the resolver once the user has set its own
resolver. resolver.
''; '';