nixos/doc: fix some options

+1 -1
nixos/modules/programs/htop.nix
···
package = mkOption {
type = types.package;
default = pkgs.htop;
-
defaultText = "pkgs.htop";
description = lib.mdDoc ''
The htop package that should be used.
'';
···
package = mkOption {
type = types.package;
default = pkgs.htop;
+
defaultText = lib.literalExpression "pkgs.htop";
description = lib.mdDoc ''
The htop package that should be used.
'';
+1 -1
nixos/modules/programs/weylus.nix
···
package = mkOption {
type = package;
default = pkgs.weylus;
-
defaultText = "pkgs.weylus";
description = lib.mdDoc "Weylus package to install.";
};
};
···
package = mkOption {
type = package;
default = pkgs.weylus;
+
defaultText = lib.literalExpression "pkgs.weylus";
description = lib.mdDoc "Weylus package to install.";
};
};
+7 -5
nixos/modules/services/audio/liquidsoap.nix
···
default = {};
-
example = {
-
myStream1 = "/etc/liquidsoap/myStream1.liq";
-
myStream2 = literalExpression "./myStream2.liq";
-
myStream3 = "out(playlist(\"/srv/music/\"))";
-
};
type = types.attrsOf (types.either types.path types.str);
};
···
default = {};
+
example = literalExpression ''
+
{
+
myStream1 = "/etc/liquidsoap/myStream1.liq";
+
myStream2 = ./myStream2.liq;
+
myStream3 = "out(playlist(\"/srv/music/\"))";
+
}
+
'';
type = types.attrsOf (types.either types.path types.str);
};
+1 -1
nixos/modules/services/databases/clickhouse.nix
···
package = mkOption {
type = types.package;
default = pkgs.clickhouse;
-
defaultText = "pkgs.clickhouse";
description = lib.mdDoc ''
ClickHouse package to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.clickhouse;
+
defaultText = lib.literalExpression "pkgs.clickhouse";
description = lib.mdDoc ''
ClickHouse package to use.
'';
+6 -4
nixos/modules/services/databases/mysql.nix
···
List of database names and their initial schemas that should be used to create databases on the first startup
of MySQL. The schema attribute is optional: If not specified, an empty database is created.
'';
-
example = [
-
{ name = "foodatabase"; schema = literalExpression "./foodatabase.sql"; }
-
{ name = "bardatabase"; }
-
];
};
initialScript = mkOption {
···
List of database names and their initial schemas that should be used to create databases on the first startup
of MySQL. The schema attribute is optional: If not specified, an empty database is created.
'';
+
example = literalExpression ''
+
[
+
{ name = "foodatabase"; schema = ./foodatabase.sql; }
+
{ name = "bardatabase"; }
+
]
+
'';
};
initialScript = mkOption {
+1 -1
nixos/modules/services/databases/openldap.nix
···
# systemd/systemd#19604
description = ''
LDAP value - either a string, or an attrset containing
-
<literal>path</literal> or <literal>base64</literal> for included
values or base-64 encoded values respectively.
'';
check = x: lib.isString x || (lib.isAttrs x && (x ? path || x ? base64));
···
# systemd/systemd#19604
description = ''
LDAP value - either a string, or an attrset containing
+
`path` or `base64` for included
values or base-64 encoded values respectively.
'';
check = x: lib.isString x || (lib.isAttrs x && (x ? path || x ? base64));
+5 -3
nixos/modules/services/games/asf.nix
···
web-ui = mkOption {
type = types.submodule {
options = {
-
enable = mkEnableOption
-
(lib.mdDoc "Wheter to start the web-ui. This is the preferred way of configuring things such as the steam guard token");
package = mkOption {
type = types.package;
default = pkgs.ArchiSteamFarm.ui;
description =
lib.mdDoc "Web-UI package to use. Contents must be in lib/dist.";
};
···
};
default = {
enable = true;
-
package = pkgs.ArchiSteamFarm.ui;
};
example = {
enable = false;
···
package = mkOption {
type = types.package;
default = pkgs.ArchiSteamFarm;
description =
lib.mdDoc "Package to use. Should always be the latest version, for security reasons, since this module uses very new features and to not get out of sync with the Steam API.";
};
···
web-ui = mkOption {
type = types.submodule {
options = {
+
enable = mkEnableOption "" // {
+
description = lib.mdDoc "Whether to start the web-ui. This is the preferred way of configuring things such as the steam guard token.";
+
};
package = mkOption {
type = types.package;
default = pkgs.ArchiSteamFarm.ui;
+
defaultText = lib.literalExpression "pkgs.ArchiSteamFarm.ui";
description =
lib.mdDoc "Web-UI package to use. Contents must be in lib/dist.";
};
···
};
default = {
enable = true;
};
example = {
enable = false;
···
package = mkOption {
type = types.package;
default = pkgs.ArchiSteamFarm;
+
defaultText = lib.literalExpression "pkgs.ArchiSteamFarm";
description =
lib.mdDoc "Package to use. Should always be the latest version, for security reasons, since this module uses very new features and to not get out of sync with the Steam API.";
};
+1 -1
nixos/modules/services/games/terraria.nix
···
openFirewall = mkOption {
type = types.bool;
default = false;
-
description = lib.mdDoc "Wheter to open ports in the firewall";
};
dataDir = mkOption {
···
openFirewall = mkOption {
type = types.bool;
default = false;
+
description = lib.mdDoc "Whether to open ports in the firewall";
};
dataDir = mkOption {
+1 -1
nixos/modules/services/hardware/argonone.nix
···
package = lib.mkOption {
type = lib.types.package;
default = pkgs.argononed;
-
defaultText = "pkgs.argononed";
description = lib.mdDoc ''
The package implementing the Argon One driver
'';
···
package = lib.mkOption {
type = lib.types.package;
default = pkgs.argononed;
+
defaultText = lib.literalExpression "pkgs.argononed";
description = lib.mdDoc ''
The package implementing the Argon One driver
'';
+1 -1
nixos/modules/services/hardware/joycond.nix
···
package = mkOption {
type = types.package;
default = pkgs.joycond;
-
defaultText = "pkgs.joycond";
description = lib.mdDoc ''
The joycond package to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.joycond;
+
defaultText = lib.literalExpression "pkgs.joycond";
description = lib.mdDoc ''
The joycond package to use.
'';
+1 -2
nixos/modules/services/matrix/conduit.nix
···
package = mkOption {
type = types.package;
default = pkgs.matrix-conduit;
-
defaultText = "pkgs.matrix-conduit";
-
example = "pkgs.matrix-conduit";
description = lib.mdDoc ''
Package of the conduit matrix server to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.matrix-conduit;
+
defaultText = lib.literalExpression "pkgs.matrix-conduit";
description = lib.mdDoc ''
Package of the conduit matrix server to use.
'';
+1
nixos/modules/services/matrix/synapse.nix
···
log_config = mkOption {
type = types.path;
default = ./synapse-log_config.yaml;
description = lib.mdDoc ''
The file that holds the logging configuration.
'';
···
log_config = mkOption {
type = types.path;
default = ./synapse-log_config.yaml;
+
defaultText = lib.literalExpression "nixos/modules/services/matrix/synapse-log_config.yaml";
description = lib.mdDoc ''
The file that holds the logging configuration.
'';
+2 -2
nixos/modules/services/misc/autorandr.nix
···
type = hooksModule;
description = lib.mdDoc "Global hook scripts";
default = { };
-
example = ''
{
postswitch = {
"notify-i3" = "''${pkgs.i3}/bin/i3-msg restart";
···
exit 1
esac
echo "Xft.dpi: $DPI" | ''${pkgs.xorg.xrdb}/bin/xrdb -merge
-
'''
};
}
'';
···
type = hooksModule;
description = lib.mdDoc "Global hook scripts";
default = { };
+
example = literalExpression ''
{
postswitch = {
"notify-i3" = "''${pkgs.i3}/bin/i3-msg restart";
···
exit 1
esac
echo "Xft.dpi: $DPI" | ''${pkgs.xorg.xrdb}/bin/xrdb -merge
+
''';
};
}
'';
+1 -2
nixos/modules/services/misc/heisenbridge.nix
···
package = mkOption {
type = types.package;
default = pkgs.heisenbridge;
-
defaultText = "pkgs.heisenbridge";
-
example = "pkgs.heisenbridge.override { … = …; }";
description = lib.mdDoc ''
Package of the application to run, exposed for overriding purposes.
'';
···
package = mkOption {
type = types.package;
default = pkgs.heisenbridge;
+
defaultText = lib.literalExpression "pkgs.heisenbridge";
description = lib.mdDoc ''
Package of the application to run, exposed for overriding purposes.
'';
+2 -2
nixos/modules/services/misc/portunus.nix
···
package = mkOption {
type = types.package;
default = pkgs.portunus;
-
defaultText = "pkgs.portunus";
description = lib.mdDoc "The Portunus package to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.openldap;
-
defaultText = "pkgs.openldap";
description = lib.mdDoc "The OpenLDAP package to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.portunus;
+
defaultText = lib.literalExpression "pkgs.portunus";
description = lib.mdDoc "The Portunus package to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.openldap;
+
defaultText = lib.literalExpression "pkgs.openldap";
description = lib.mdDoc "The OpenLDAP package to use.";
};
+1 -1
nixos/modules/services/misc/sourcehut/default.nix
···
description = lib.mdDoc "Origin URL for API, 100 more than web.";
type = types.str;
default = "http://${cfg.listenAddress}:${toString (cfg.meta.port + 100)}";
-
defaultText = ''http://<xref linkend="opt-services.sourcehut.listenAddress"/>:''${toString (<xref linkend="opt-services.sourcehut.meta.port"/> + 100)}'';
};
webhooks = mkOption {
description = lib.mdDoc "The Redis connection used for the webhooks worker.";
···
description = lib.mdDoc "Origin URL for API, 100 more than web.";
type = types.str;
default = "http://${cfg.listenAddress}:${toString (cfg.meta.port + 100)}";
+
defaultText = lib.literalMD ''`"http://''${`[](#opt-services.sourcehut.listenAddress)`}:''${toString (`[](#opt-services.sourcehut.meta.port)` + 100)}"`'';
};
webhooks = mkOption {
description = lib.mdDoc "The Redis connection used for the webhooks worker.";
+14 -12
nixos/modules/services/monitoring/grafana-agent.nix
···
package = mkOption {
type = types.package;
default = pkgs.grafana-agent;
-
defaultText = "pkgs.grafana-agent";
description = lib.mdDoc "The grafana-agent package to use.";
};
···
};
default = { };
-
defaultText = ''
-
metrics = {
-
wal_directory = "\''${STATE_DIRECTORY}";
-
global.scrape_interval = "5s";
-
};
-
integrations = {
-
agent.enabled = true;
-
agent.scrape_integration = true;
-
node_exporter.enabled = true;
-
replace_instance_label = true;
-
};
'';
example = {
metrics.global.remote_write = [{
···
package = mkOption {
type = types.package;
default = pkgs.grafana-agent;
+
defaultText = lib.literalExpression "pkgs.grafana-agent";
description = lib.mdDoc "The grafana-agent package to use.";
};
···
};
default = { };
+
defaultText = lib.literalExpression ''
+
{
+
metrics = {
+
wal_directory = "\''${STATE_DIRECTORY}";
+
global.scrape_interval = "5s";
+
};
+
integrations = {
+
agent.enabled = true;
+
agent.scrape_integration = true;
+
node_exporter.enabled = true;
+
replace_instance_label = true;
+
};
+
}
'';
example = {
metrics.global.remote_write = [{
+1 -2
nixos/modules/services/monitoring/uptime-kuma.nix
···
package = mkOption {
type = types.package;
-
example = literalExpression "pkgs.uptime-kuma";
default = pkgs.uptime-kuma;
-
defaultText = "pkgs.uptime-kuma";
description = lib.mdDoc "Uptime Kuma package to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.uptime-kuma;
+
defaultText = literalExpression "pkgs.uptime-kuma";
description = lib.mdDoc "Uptime Kuma package to use.";
};
+1 -1
nixos/modules/services/networking/ddclient.nix
···
package = mkOption {
type = package;
default = pkgs.ddclient;
-
defaultText = "pkgs.ddclient";
description = lib.mdDoc ''
The ddclient executable package run by the service.
'';
···
package = mkOption {
type = package;
default = pkgs.ddclient;
+
defaultText = lib.literalExpression "pkgs.ddclient";
description = lib.mdDoc ''
The ddclient executable package run by the service.
'';
+2 -2
nixos/modules/services/networking/ergochat.nix
···
configFile = lib.mkOption {
type = lib.types.path;
default = (pkgs.formats.yaml {}).generate "ergo.conf" cfg.settings;
-
defaultText = "generated config file from <literal>.settings</literal>";
description = lib.mdDoc ''
Path to configuration file.
-
Setting this will skip any configuration done via `.settings`
'';
};
···
configFile = lib.mkOption {
type = lib.types.path;
default = (pkgs.formats.yaml {}).generate "ergo.conf" cfg.settings;
+
defaultText = lib.literalMD "generated config file from `settings`";
description = lib.mdDoc ''
Path to configuration file.
+
Setting this will skip any configuration done via `settings`
'';
};
+1 -1
nixos/modules/services/networking/multipath.nix
···
type = package;
description = lib.mdDoc "multipath-tools package to use";
default = pkgs.multipath-tools;
-
defaultText = "pkgs.multipath-tools";
};
devices = mkOption {
···
type = package;
description = lib.mdDoc "multipath-tools package to use";
default = pkgs.multipath-tools;
+
defaultText = lib.literalExpression "pkgs.multipath-tools";
};
devices = mkOption {
+1 -1
nixos/modules/services/networking/nomad.nix
···
Additional plugins dir used to configure nomad.
'';
example = literalExpression ''
-
[ "<pluginDir>" "pkgs.<plugins-name>"]
'';
};
···
Additional plugins dir used to configure nomad.
'';
example = literalExpression ''
+
[ "<pluginDir>" pkgs.<plugins-name> ]
'';
};
+1 -1
nixos/modules/services/networking/sabnzbd.nix
···
package = mkOption {
type = types.package;
default = pkgs.sabnzbd;
-
defaultText = "pkgs.sabnzbd";
description = lib.mdDoc "The sabnzbd executable package run by the service.";
};
···
package = mkOption {
type = types.package;
default = pkgs.sabnzbd;
+
defaultText = lib.literalExpression "pkgs.sabnzbd";
description = lib.mdDoc "The sabnzbd executable package run by the service.";
};
+1 -1
nixos/modules/services/search/meilisearch.nix
···
package = mkOption {
description = lib.mdDoc "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features.";
default = pkgs.meilisearch;
-
defaultText = "pkgs.meilisearch";
type = types.package;
};
···
package = mkOption {
description = lib.mdDoc "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features.";
default = pkgs.meilisearch;
+
defaultText = lib.literalExpression "pkgs.meilisearch";
type = types.package;
};
+1 -1
nixos/modules/services/security/opensnitch.nix
···
InterceptUnknown = mkOption {
type = types.bool;
description = mdDoc ''
-
Wheter to intercept spare connections.
'';
};
···
InterceptUnknown = mkOption {
type = types.bool;
description = mdDoc ''
+
Whether to intercept spare connections.
'';
};
+1 -1
nixos/modules/services/web-apps/code-server.nix
···
package = mkOption {
default = pkgs.code-server;
-
defaultText = "pkgs.code-server";
description = lib.mdDoc "Which code-server derivation to use.";
type = types.package;
};
···
package = mkOption {
default = pkgs.code-server;
+
defaultText = lib.literalExpression "pkgs.code-server";
description = lib.mdDoc "Which code-server derivation to use.";
type = types.package;
};
+1 -1
nixos/modules/services/web-apps/invidious.nix
···
package = lib.mkOption {
type = types.package;
default = pkgs.invidious;
-
defaultText = "pkgs.invidious";
description = lib.mdDoc "The Invidious package to use.";
};
···
package = lib.mkOption {
type = types.package;
default = pkgs.invidious;
+
defaultText = lib.literalExpression "pkgs.invidious";
description = lib.mdDoc "The Invidious package to use.";
};
+2 -2
nixos/modules/services/web-apps/mattermost.nix
···
package = mkOption {
type = types.package;
default = pkgs.mattermost;
-
defaultText = "pkgs.mattermost";
description = lib.mdDoc "Mattermost derivation to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.matterircd;
-
defaultText = "pkgs.matterircd";
description = lib.mdDoc "matterircd derivation to use.";
};
parameters = mkOption {
···
package = mkOption {
type = types.package;
default = pkgs.mattermost;
+
defaultText = lib.literalExpression "pkgs.mattermost";
description = lib.mdDoc "Mattermost derivation to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.matterircd;
+
defaultText = lib.literalExpression "pkgs.matterircd";
description = lib.mdDoc "matterircd derivation to use.";
};
parameters = mkOption {
+1 -1
nixos/modules/services/web-apps/onlyoffice.nix
···
package = mkOption {
type = types.package;
default = pkgs.onlyoffice-documentserver;
-
defaultText = "pkgs.onlyoffice-documentserver";
description = lib.mdDoc "Which package to use for the OnlyOffice instance.";
};
···
package = mkOption {
type = types.package;
default = pkgs.onlyoffice-documentserver;
+
defaultText = lib.literalExpression "pkgs.onlyoffice-documentserver";
description = lib.mdDoc "Which package to use for the OnlyOffice instance.";
};
+1 -1
nixos/modules/services/web-servers/lighttpd/default.nix
···
package = mkOption {
default = pkgs.lighttpd;
-
defaultText = "pkgs.lighttpd";
type = types.package;
description = lib.mdDoc ''
lighttpd package to use.
···
package = mkOption {
default = pkgs.lighttpd;
+
defaultText = lib.literalExpression "pkgs.lighttpd";
type = types.package;
description = lib.mdDoc ''
lighttpd package to use.
+5 -4
nixos/modules/virtualisation/qemu-vm.nix
···
virtualisation.host.pkgs = mkOption {
type = options.nixpkgs.pkgs.type;
default = pkgs;
-
defaultText = "pkgs";
example = literalExpression ''
import pkgs.path { system = "x86_64-darwin"; }
'';
···
mkOption {
type = types.package;
default = cfg.host.pkgs.qemu_kvm;
-
example = "pkgs.qemu_test";
description = lib.mdDoc "QEMU package to use.";
};
···
firmware = mkOption {
type = types.path;
default = pkgs.OVMF.firmware;
-
defaultText = "pkgs.OVMF.firmware";
description =
lib.mdDoc ''
Firmware binary for EFI implementation, defaults to OVMF.
···
variables = mkOption {
type = types.path;
default = pkgs.OVMF.variables;
-
defaultText = "pkgs.OVMF.variables";
description =
lib.mdDoc ''
Platform-specific flash binary for EFI variables, implementation-dependent to the EFI firmware.
···
virtualisation.host.pkgs = mkOption {
type = options.nixpkgs.pkgs.type;
default = pkgs;
+
defaultText = literalExpression "pkgs";
example = literalExpression ''
import pkgs.path { system = "x86_64-darwin"; }
'';
···
mkOption {
type = types.package;
default = cfg.host.pkgs.qemu_kvm;
+
defaultText = literalExpression "config.virtualisation.host.pkgs.qemu_kvm";
+
example = literalExpression "pkgs.qemu_test";
description = lib.mdDoc "QEMU package to use.";
};
···
firmware = mkOption {
type = types.path;
default = pkgs.OVMF.firmware;
+
defaultText = literalExpression "pkgs.OVMF.firmware";
description =
lib.mdDoc ''
Firmware binary for EFI implementation, defaults to OVMF.
···
variables = mkOption {
type = types.path;
default = pkgs.OVMF.variables;
+
defaultText = literalExpression "pkgs.OVMF.variables";
description =
lib.mdDoc ''
Platform-specific flash binary for EFI variables, implementation-dependent to the EFI firmware.