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

nixos/*: md-convert hidden plaintext options

Browse Source 
most of these are hidden because they're either part of a submodule that
doesn't have its type rendered (eg because the submodule type is used in
an either type) or because they are explicitly hidden. some of them are
merely hidden from nix-doc-munge by how their option is put together.
This commit is contained in:
pennae
2022-08-29 19:33:50 +02:00
parent 515c4727fa
commit bd56368848
27 changed files with 75 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
nixos/maintainers/scripts/ec2/amazon-image.nix
View File

@@ -23,7 +23,7 @@ in {
options.amazonImage = { options.amazonImage = {
name = mkOption { name = mkOption {
type = types.str; type = types.str;
description = "The name of the generated derivation"; description = lib.mdDoc "The name of the generated derivation";
default = "nixos-amazon-image-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}"; default = "nixos-amazon-image-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
}; };
@@ -35,7 +35,7 @@ in {
] ]
''; '';
default = []; default = [];
description = '' description = lib.mdDoc ''
This option lists files to be copied to fixed locations in the This option lists files to be copied to fixed locations in the
generated image. Glob patterns work. generated image. Glob patterns work.
''; '';
@@ -45,13 +45,13 @@ in {
type = with types; either (enum [ "auto" ]) int; type = with types; either (enum [ "auto" ]) int;
default = if config.ec2.hvm then 2048 else 8192; default = if config.ec2.hvm then 2048 else 8192;
example = 8192; example = 8192;
description = "The size in MB of the image"; description = lib.mdDoc "The size in MB of the image";
}; };
format = mkOption { format = mkOption {
type = types.enum [ "raw" "qcow2" "vpc" ]; type = types.enum [ "raw" "qcow2" "vpc" ];
default = "vpc"; default = "vpc";
description = "The image format to output"; description = lib.mdDoc "The image format to output";
}; };
}; };

2
nixos/modules/misc/documentation/test.nix
View File

@@ -30,7 +30,7 @@ let
specialArgs.someArg.myModule = { lib, ... }: { specialArgs.someArg.myModule = { lib, ... }: {
options.foobar = lib.mkOption { options.foobar = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "The foobar option was added via specialArgs"; description = lib.mdDoc "The foobar option was added via specialArgs";
default = "qux"; default = "qux";
}; };
}; };

6
nixos/modules/programs/firejail.nix
View File

@@ -39,19 +39,19 @@ in {
options = { options = {
executable = mkOption { executable = mkOption {
type = types.path; type = types.path;
description = "Executable to run sandboxed"; description = lib.mdDoc "Executable to run sandboxed";
example = literalExpression ''"''${lib.getBin pkgs.firefox}/bin/firefox"''; example = literalExpression ''"''${lib.getBin pkgs.firefox}/bin/firefox"'';
}; };
profile = mkOption { profile = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
description = "Profile to use"; description = lib.mdDoc "Profile to use";
example = literalExpression ''"''${pkgs.firejail}/etc/firejail/firefox.profile"''; example = literalExpression ''"''${pkgs.firejail}/etc/firejail/firefox.profile"'';
}; };
extraArgs = mkOption { extraArgs = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
description = "Extra arguments to pass to firejail"; description = lib.mdDoc "Extra arguments to pass to firejail";
example = [ "--private=~/.firejail_home" ]; example = [ "--private=~/.firejail_home" ];
}; };
}; };

8
nixos/modules/security/sudo.nix
View File

@@ -157,17 +157,17 @@ in
options = { options = {
command = mkOption { command = mkOption {
type = with types; str; type = with types; str;
description = '' description = lib.mdDoc ''
A command being either just a path to a binary to allow any arguments, A command being either just a path to a binary to allow any arguments,
the full command with arguments pre-set or with <literal>""</literal> used as the argument, the full command with arguments pre-set or with `""` used as the argument,
not allowing arguments to the command at all. not allowing arguments to the command at all.
''; '';
}; };
options = mkOption { options = mkOption {
type = with types; listOf (enum [ "NOPASSWD" "PASSWD" "NOEXEC" "EXEC" "SETENV" "NOSETENV" "LOG_INPUT" "NOLOG_INPUT" "LOG_OUTPUT" "NOLOG_OUTPUT" ]); type = with types; listOf (enum [ "NOPASSWD" "PASSWD" "NOEXEC" "EXEC" "SETENV" "NOSETENV" "LOG_INPUT" "NOLOG_INPUT" "LOG_OUTPUT" "NOLOG_OUTPUT" ]);
description = '' description = lib.mdDoc ''
Options for running the command. Refer to the <a href="https://www.sudo.ws/man/1.7.10/sudoers.man.html">sudo manual</a>. Options for running the command. Refer to the [sudo manual](https://www.sudo.ws/man/1.7.10/sudoers.man.html).
''; '';
default = []; default = [];
}; };

4
nixos/modules/services/hardware/sane_extra_backends/brscan4.nix
View File

@@ -68,8 +68,8 @@ in
options = { options = {
hardware.sane.brscan4.enable = hardware.sane.brscan4.enable =
mkEnableOption "Brother's brscan4 scan backend" // { mkEnableOption (lib.mdDoc "Brother's brscan4 scan backend") // {
description = '' description = lib.mdDoc ''
When enabled, will automatically register the "brscan4" sane When enabled, will automatically register the "brscan4" sane
backend and bring configuration files to their expected location. backend and bring configuration files to their expected location.
''; '';

4
nixos/modules/services/hardware/sane_extra_backends/dsseries.nix
View File

@@ -6,8 +6,8 @@ with lib;
options = { options = {
hardware.sane.dsseries.enable = hardware.sane.dsseries.enable =
mkEnableOption "Brother DSSeries scan backend" // { mkEnableOption (lib.mdDoc "Brother DSSeries scan backend") // {
description = '' description = lib.mdDoc ''
When enabled, will automatically register the "dsseries" SANE backend. When enabled, will automatically register the "dsseries" SANE backend.
This supports the Brother DSmobile scanner series, including the This supports the Brother DSmobile scanner series, including the

8
nixos/modules/services/mail/postgrey.nix
View File

@@ -15,12 +15,12 @@ with lib; let
type = nullOr str; type = nullOr str;
default = null; default = null;
example = "127.0.0.1"; example = "127.0.0.1";
description = "The address to bind to. Localhost if null"; description = lib.mdDoc "The address to bind to. Localhost if null";
}; };
port = mkOption { port = mkOption {
type = natural'; type = natural';
default = 10030; default = 10030;
description = "Tcp port to bind to"; description = lib.mdDoc "Tcp port to bind to";
}; };
}; };
}; };
@@ -30,13 +30,13 @@ with lib; let
path = mkOption { path = mkOption {
type = path; type = path;
default = "/run/postgrey.sock"; default = "/run/postgrey.sock";
description = "Path of the unix socket"; description = lib.mdDoc "Path of the unix socket";
}; };
mode = mkOption { mode = mkOption {
type = str; type = str;
default = "0777"; default = "0777";
description = "Mode of the unix socket"; description = lib.mdDoc "Mode of the unix socket";
}; };
}; };
}; };

8
nixos/modules/services/mail/rspamd.nix
View File

@@ -13,24 +13,24 @@ let
socket = mkOption { socket = mkOption {
type = types.str; type = types.str;
example = "localhost:11333"; example = "localhost:11333";
description = '' description = lib.mdDoc ''
Socket for this worker to listen on in a format acceptable by rspamd. Socket for this worker to listen on in a format acceptable by rspamd.
''; '';
}; };
mode = mkOption { mode = mkOption {
type = types.str; type = types.str;
default = "0644"; default = "0644";
description = "Mode to set on unix socket"; description = lib.mdDoc "Mode to set on unix socket";
}; };
owner = mkOption { owner = mkOption {
type = types.str; type = types.str;
default = "${cfg.user}"; default = "${cfg.user}";
description = "Owner to set on unix socket"; description = lib.mdDoc "Owner to set on unix socket";
}; };
group = mkOption { group = mkOption {
type = types.str; type = types.str;
default = "${cfg.group}"; default = "${cfg.group}";
description = "Group to set on unix socket"; description = lib.mdDoc "Group to set on unix socket";
}; };
rawEntry = mkOption { rawEntry = mkOption {
type = types.str; type = types.str;

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

@@ -83,7 +83,7 @@ in {
}; };
network = mkOption { network = mkOption {
description = " IPv4 network in CIDR format to use for the entire flannel network."; description = lib.mdDoc " IPv4 network in CIDR format to use for the entire flannel network.";
type = types.str; type = types.str;
}; };

12
nixos/modules/services/networking/i2pd.nix
View File

@@ -247,8 +247,8 @@ in
services.i2pd = { services.i2pd = {
enable = mkEnableOption "I2Pd daemon" // { enable = mkEnableOption (lib.mdDoc "I2Pd daemon") // {
description = '' description = lib.mdDoc ''
Enables I2Pd as a running service upon activation. Enables I2Pd as a running service upon activation.
Please read http://i2pd.readthedocs.io/en/latest/ for further Please read http://i2pd.readthedocs.io/en/latest/ for further
configuration help. configuration help.
@@ -345,14 +345,14 @@ in
ntcp = mkEnableTrueOption "ntcp"; ntcp = mkEnableTrueOption "ntcp";
ssu = mkEnableTrueOption "ssu"; ssu = mkEnableTrueOption "ssu";
notransit = mkEnableOption "notransit" // { notransit = mkEnableOption (lib.mdDoc "notransit") // {
description = '' description = lib.mdDoc ''
Tells the router to not accept transit tunnels during startup. Tells the router to not accept transit tunnels during startup.
''; '';
}; };
floodfill = mkEnableOption "floodfill" // { floodfill = mkEnableOption (lib.mdDoc "floodfill") // {
description = '' description = lib.mdDoc ''
If the router is declared to be unreachable and needs introduction nodes. If the router is declared to be unreachable and needs introduction nodes.
''; '';
}; };

6
nixos/modules/services/networking/smokeping.nix
View File

@@ -82,8 +82,10 @@ in
config = mkOption { config = mkOption {
type = types.nullOr types.lines; type = types.nullOr types.lines;
default = null; default = null;
description = "Full smokeping config supplied by the user. Overrides " + description = lib.mdDoc ''
"and replaces any other configuration supplied."; Full smokeping config supplied by the user. Overrides
and replaces any other configuration supplied.
'';
}; };
databaseConfig = mkOption { databaseConfig = mkOption {
type = types.lines; type = types.lines;

6
nixos/modules/services/networking/x2goserver.nix
View File

@@ -23,15 +23,15 @@ in {
options.services.x2goserver = { options.services.x2goserver = {
enable = mkEnableOption (lib.mdDoc "x2goserver") // { enable = mkEnableOption (lib.mdDoc "x2goserver") // {
description = '' description = lib.mdDoc ''
Enables the x2goserver module. Enables the x2goserver module.
NOTE: This will create a good amount of symlinks in `/usr/local/bin` NOTE: This will create a good amount of symlinks in `/usr/local/bin`
''; '';
}; };
superenicer = { superenicer = {
enable = mkEnableOption "superenicer" // { enable = mkEnableOption (lib.mdDoc "superenicer") // {
description = '' description = lib.mdDoc ''
Enables the SupeReNicer code in x2gocleansessions, this will renice Enables the SupeReNicer code in x2gocleansessions, this will renice
suspended sessions to nice level 19 and renice them to level 0 if the suspended sessions to nice level 19 and renice them to level 0 if the
session becomes marked as running again session becomes marked as running again

12
nixos/modules/services/security/certmgr.nix
View File

@@ -118,34 +118,34 @@ in
service = mkOption { service = mkOption {
type = nullOr str; type = nullOr str;
default = null; default = null;
description = "The service on which to perform &lt;action&gt; after fetching."; description = lib.mdDoc "The service on which to perform \<action\> after fetching.";
}; };
action = mkOption { action = mkOption {
type = addCheck str (x: cfg.svcManager == "command" || elem x ["restart" "reload" "nop"]); type = addCheck str (x: cfg.svcManager == "command" || elem x ["restart" "reload" "nop"]);
default = "nop"; default = "nop";
description = "The action to take after fetching."; description = lib.mdDoc "The action to take after fetching.";
}; };
# These ought all to be specified according to certmgr spec def. # These ought all to be specified according to certmgr spec def.
authority = mkOption { authority = mkOption {
type = attrs; type = attrs;
description = "certmgr spec authority object."; description = lib.mdDoc "certmgr spec authority object.";
}; };
certificate = mkOption { certificate = mkOption {
type = nullOr attrs; type = nullOr attrs;
description = "certmgr spec certificate object."; description = lib.mdDoc "certmgr spec certificate object.";
}; };
private_key = mkOption { private_key = mkOption {
type = nullOr attrs; type = nullOr attrs;
description = "certmgr spec private_key object."; description = lib.mdDoc "certmgr spec private_key object.";
}; };
request = mkOption { request = mkOption {
type = nullOr attrs; type = nullOr attrs;
description = "certmgr spec request object."; description = lib.mdDoc "certmgr spec request object.";
}; };
}; };
})); }));

4
nixos/modules/services/security/tor.nix
View File

@@ -51,14 +51,14 @@ let
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
example = "0.0.0.0"; example = "0.0.0.0";
description = '' description = lib.mdDoc ''
IPv4 or IPv6 (if between brackets) address. IPv4 or IPv6 (if between brackets) address.
''; '';
}; };
optionUnix = mkOption { optionUnix = mkOption {
type = with types; nullOr path; type = with types; nullOr path;
default = null; default = null;
description = '' description = lib.mdDoc ''
Unix domain socket path to use. Unix domain socket path to use.
''; '';
}; };

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

@@ -234,7 +234,7 @@ in {
options = { options = {
_secret = mkOption { _secret = mkOption {
type = nullOr str; type = nullOr str;
description = '' description = lib.mdDoc ''
The path to a file containing the value the The path to a file containing the value the
option should be set to in the final option should be set to in the final
configuration file. configuration file.

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

@@ -26,8 +26,8 @@ let
in in
{ {
options.services.healthchecks = { options.services.healthchecks = {
enable = mkEnableOption "healthchecks" // { enable = mkEnableOption (lib.mdDoc "healthchecks") // {
description = '' description = lib.mdDoc ''
Enable healthchecks. Enable healthchecks.
It is expected to be run behind a HTTP reverse proxy. It is expected to be run behind a HTTP reverse proxy.
''; '';

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

@@ -250,7 +250,7 @@ in {
options = { options = {
_secret = mkOption { _secret = mkOption {
type = nullOr (oneOf [ str path ]); type = nullOr (oneOf [ str path ]);
description = '' description = lib.mdDoc ''
The path to a file containing the value the The path to a file containing the value the
option should be set to in the final option should be set to in the final
configuration file. configuration file.

12
nixos/modules/services/x11/desktop-managers/phosh.nix
View File

@@ -33,14 +33,14 @@ let
default = "false"; default = "false";
}; };
cursorTheme = mkOption { cursorTheme = mkOption {
description = '' description = lib.mdDoc ''
Cursor theme to use in Phosh. Cursor theme to use in Phosh.
''; '';
type = types.str; type = types.str;
default = "default"; default = "default";
}; };
outputs = mkOption { outputs = mkOption {
description = '' description = lib.mdDoc ''
Output configurations. Output configurations.
''; '';
type = types.attrsOf phocOutputType; type = types.attrsOf phocOutputType;
@@ -56,7 +56,7 @@ let
phocOutputType = types.submodule { phocOutputType = types.submodule {
options = { options = {
modeline = mkOption { modeline = mkOption {
description = '' description = lib.mdDoc ''
One or more modelines. One or more modelines.
''; '';
type = types.either types.str (types.listOf types.str); type = types.either types.str (types.listOf types.str);
@@ -67,7 +67,7 @@ let
]; ];
}; };
mode = mkOption { mode = mkOption {
description = '' description = lib.mdDoc ''
Default video mode. Default video mode.
''; '';
type = types.nullOr types.str; type = types.nullOr types.str;
@@ -75,7 +75,7 @@ let
example = "768x1024"; example = "768x1024";
}; };
scale = mkOption { scale = mkOption {
description = '' description = lib.mdDoc ''
Display scaling factor. Display scaling factor.
''; '';
type = types.nullOr ( type = types.nullOr (
@@ -89,7 +89,7 @@ let
example = 2; example = 2;
}; };
rotate = mkOption { rotate = mkOption {
description = '' description = lib.mdDoc ''
Screen transformation. Screen transformation.
''; '';
type = types.enum [ type = types.enum [

4
nixos/modules/services/x11/display-managers/sx.nix
View File

@@ -7,8 +7,8 @@ let cfg = config.services.xserver.displayManager.sx;
in { in {
options = { options = {
services.xserver.displayManager.sx = { services.xserver.displayManager.sx = {
enable = mkEnableOption "sx pseudo-display manager" // { enable = mkEnableOption (lib.mdDoc "sx pseudo-display manager") // {
description = '' description = lib.mdDoc ''
Whether to enable the "sx" pseudo-display manager, which allows users Whether to enable the "sx" pseudo-display manager, which allows users
to start manually via the "sx" command from a vt shell. The X server to start manually via the "sx" command from a vt shell. The X server
runs under the user's id, not as root. The user must provide a runs under the user's id, not as root. The user must provide a

4
nixos/modules/services/x11/xautolock.nix
View File

@@ -9,8 +9,8 @@ in
options = { options = {
services.xserver.xautolock = { services.xserver.xautolock = {
enable = mkEnableOption (lib.mdDoc "xautolock"); enable = mkEnableOption (lib.mdDoc "xautolock");
enableNotifier = mkEnableOption "xautolock.notify" // { enableNotifier = mkEnableOption (lib.mdDoc "xautolock.notify") // {
description = '' description = lib.mdDoc ''
Whether to enable the notifier feature of xautolock. Whether to enable the notifier feature of xautolock.
This publishes a notification before the autolock. This publishes a notification before the autolock.
''; '';

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

@@ -78,11 +78,11 @@ let
{ deps = mkOption { deps = mkOption
{ type = types.listOf types.str; { type = types.listOf types.str;
default = [ ]; default = [ ];
description = "List of dependencies. The script will run after these."; description = lib.mdDoc "List of dependencies. The script will run after these.";
}; };
text = mkOption text = mkOption
{ type = types.lines; { type = types.lines;
description = "The content of the script."; description = lib.mdDoc "The content of the script.";
}; };
} // optionalAttrs withDry { } // optionalAttrs withDry {
supportsDryActivation = mkOption supportsDryActivation = mkOption

2
nixos/modules/tasks/bcache.nix
View File

@@ -1,7 +1,7 @@
{ config, lib, pkgs, ... }: { config, lib, pkgs, ... }:
{ {
options.boot.initrd.services.bcache.enable = (lib.mkEnableOption "bcache support in the initrd") // { options.boot.initrd.services.bcache.enable = (lib.mkEnableOption (lib.mdDoc "bcache support in the initrd")) // {
visible = false; # only works with systemd stage 1 visible = false; # only works with systemd stage 1
}; };

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

@@ -21,7 +21,7 @@ in {
boot.vdo.enable = mkEnableOption (lib.mdDoc "support for booting from VDOLVs"); boot.vdo.enable = mkEnableOption (lib.mdDoc "support for booting from VDOLVs");
}; };
options.boot.initrd.services.lvm.enable = (mkEnableOption "enable booting from LVM2 in the initrd") // { options.boot.initrd.services.lvm.enable = (mkEnableOption (lib.mdDoc "enable booting from LVM2 in the initrd")) // {
visible = false; visible = false;
}; };

2
nixos/modules/tasks/swraid.nix
View File

@@ -5,7 +5,7 @@
in { in {
options.boot.initrd.services.swraid = { options.boot.initrd.services.swraid = {
enable = (lib.mkEnableOption "swraid support using mdadm") // { enable = (lib.mkEnableOption (lib.mdDoc "swraid support using mdadm")) // {
visible = false; # only has effect when the new stage 1 is in place visible = false; # only has effect when the new stage 1 is in place
}; };

12
nixos/modules/virtualisation/lxc-container.nix
View File

@@ -5,22 +5,22 @@ with lib;
let let
templateSubmodule = { ... }: { templateSubmodule = { ... }: {
options = { options = {
enable = mkEnableOption "this template"; enable = mkEnableOption (lib.mdDoc "this template");
target = mkOption { target = mkOption {
description = "Path in the container"; description = lib.mdDoc "Path in the container";
type = types.path; type = types.path;
}; };
template = mkOption { template = mkOption {
description = ".tpl file for rendering the target"; description = lib.mdDoc ".tpl file for rendering the target";
type = types.path; type = types.path;
}; };
when = mkOption { when = mkOption {
description = "Events which trigger a rewrite (create, copy)"; description = lib.mdDoc "Events which trigger a rewrite (create, copy)";
type = types.listOf (types.str); type = types.listOf (types.str);
}; };
properties = mkOption { properties = mkOption {
description = "Additional properties"; description = lib.mdDoc "Additional properties";
type = types.attrs; type = types.attrs;
default = {}; default = {};
}; };
@@ -58,7 +58,7 @@ in
options = { options = {
virtualisation.lxc = { virtualisation.lxc = {
templates = mkOption { templates = mkOption {
description = "Templates for LXD"; description = lib.mdDoc "Templates for LXD";
type = types.attrsOf (types.submodule (templateSubmodule)); type = types.attrsOf (types.submodule (templateSubmodule));
default = {}; default = {};
example = literalExpression '' example = literalExpression ''

6
nixos/modules/virtualisation/proxmox-lxc.nix
View File

@@ -7,14 +7,14 @@ with lib;
privileged = mkOption { privileged = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to enable privileged mounts Whether to enable privileged mounts
''; '';
}; };
manageNetwork = mkOption { manageNetwork = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to manage network interfaces through nix options Whether to manage network interfaces through nix options
When false, systemd-networkd is enabled to accept network When false, systemd-networkd is enabled to accept network
configuration from proxmox. configuration from proxmox.
@@ -23,7 +23,7 @@ with lib;
manageHostName = mkOption { manageHostName = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to manage hostname through nix options Whether to manage hostname through nix options
When false, the hostname is picked up from /etc/hostname When false, the hostname is picked up from /etc/hostname
populated by proxmox. populated by proxmox.

2
nixos/tests/systemd-confinement.nix
View File

@@ -153,7 +153,7 @@ import ./make-test-python.nix {
options.__testSteps = lib.mkOption { options.__testSteps = lib.mkOption {
type = lib.types.lines; type = lib.types.lines;
description = "All of the test steps combined as a single script."; description = lib.mdDoc "All of the test steps combined as a single script.";
}; };
config.environment.systemPackages = lib.singleton testClient; config.environment.systemPackages = lib.singleton testClient;