movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-11 20:25:32 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/doc: fix some options

Browse source
This commit is contained in:
Naïm Favier 2022-11-03 15:52:19 +01:00 • committed by pennae
parent 4cc7973ae6
commit 0ff3b35356
31 changed files with 67 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -20,7 +20,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.htop; default = pkgs.htop;
defaultText = "pkgs.htop"; defaultText = lib.literalExpression "pkgs.htop";
description = lib.mdDoc '' description = lib.mdDoc ''
The htop package that should be used. The htop package that should be used.
''; '';

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

@ -29,7 +29,7 @@ in
package = mkOption { package = mkOption {
type = package; type = package;
default = pkgs.weylus; default = pkgs.weylus;
defaultText = "pkgs.weylus"; defaultText = lib.literalExpression "pkgs.weylus";
description = lib.mdDoc "Weylus package to install."; description = lib.mdDoc "Weylus package to install.";
}; };
}; };

12
nixos/modules/services/audio/liquidsoap.nix
View file

@ -38,11 +38,13 @@ in
default = {}; default = {};
example = { example = literalExpression ''
myStream1 = "/etc/liquidsoap/myStream1.liq"; {
myStream2 = literalExpression "./myStream2.liq"; myStream1 = "/etc/liquidsoap/myStream1.liq";
myStream3 = "out(playlist(\"/srv/music/\"))"; myStream2 = ./myStream2.liq;
}; myStream3 = "out(playlist(\"/srv/music/\"))";
}
'';
type = types.attrsOf (types.either types.path types.str); type = types.attrsOf (types.either types.path types.str);
}; };

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

@ -16,7 +16,7 @@ with lib;
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.clickhouse; default = pkgs.clickhouse;
defaultText = "pkgs.clickhouse"; defaultText = lib.literalExpression "pkgs.clickhouse";
description = lib.mdDoc '' description = lib.mdDoc ''
ClickHouse package to use. ClickHouse package to use.
''; '';

10
nixos/modules/services/databases/mysql.nix
View file

@ -160,10 +160,12 @@ in
List of database names and their initial schemas that should be used to create databases on the first startup 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. of MySQL. The schema attribute is optional: If not specified, an empty database is created.
''; '';
example = [ example = literalExpression ''
{ name = "foodatabase"; schema = literalExpression "./foodatabase.sql"; } [
{ name = "bardatabase"; } { name = "foodatabase"; schema = ./foodatabase.sql; }
]; { name = "bardatabase"; }
]
'';
}; };
initialScript = mkOption { initialScript = mkOption {

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

@ -16,7 +16,7 @@ let
# systemd/systemd#19604 # systemd/systemd#19604
description = '' description = ''
LDAP value - either a string, or an attrset containing LDAP value - either a string, or an attrset containing
<literal>path</literal> or <literal>base64</literal> for included `path` or `base64` for included
values or base-64 encoded values respectively. values or base-64 encoded values respectively.
''; '';
check = x: lib.isString x || (lib.isAttrs x && (x ? path || x ? base64)); check = x: lib.isString x || (lib.isAttrs x && (x ? path || x ? base64));

8
nixos/modules/services/games/asf.nix
View file

@ -43,12 +43,14 @@ in
web-ui = mkOption { web-ui = mkOption {
type = types.submodule { type = types.submodule {
options = { options = {
enable = mkEnableOption enable = mkEnableOption "" // {
(lib.mdDoc "Wheter to start the web-ui. This is the preferred way of configuring things such as the steam guard token"); 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 { package = mkOption {
type = types.package; type = types.package;
default = pkgs.ArchiSteamFarm.ui; default = pkgs.ArchiSteamFarm.ui;
defaultText = lib.literalExpression "pkgs.ArchiSteamFarm.ui";
description = description =
lib.mdDoc "Web-UI package to use. Contents must be in lib/dist."; lib.mdDoc "Web-UI package to use. Contents must be in lib/dist.";
}; };
@ -56,7 +58,6 @@ in
}; };
default = { default = {
enable = true; enable = true;
package = pkgs.ArchiSteamFarm.ui;
}; };
example = { example = {
enable = false; enable = false;
@ -67,6 +68,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.ArchiSteamFarm; default = pkgs.ArchiSteamFarm;
defaultText = lib.literalExpression "pkgs.ArchiSteamFarm";
description = 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."; 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.";
}; };

2
nixos/modules/services/games/terraria.nix
View file

@ -116,7 +116,7 @@ in
openFirewall = mkOption { openFirewall = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = lib.mdDoc "Wheter to open ports in the firewall"; description = lib.mdDoc "Whether to open ports in the firewall";
}; };
dataDir = mkOption { dataDir = mkOption {

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

@ -9,7 +9,7 @@ in
package = lib.mkOption { package = lib.mkOption {
type = lib.types.package; type = lib.types.package;
default = pkgs.argononed; default = pkgs.argononed;
defaultText = "pkgs.argononed"; defaultText = lib.literalExpression "pkgs.argononed";
description = lib.mdDoc '' description = lib.mdDoc ''
The package implementing the Argon One driver The package implementing the Argon One driver
''; '';

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

@ -14,7 +14,7 @@ with lib;
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.joycond; default = pkgs.joycond;
defaultText = "pkgs.joycond"; defaultText = lib.literalExpression "pkgs.joycond";
description = lib.mdDoc '' description = lib.mdDoc ''
The joycond package to use. The joycond package to use.
''; '';

3
nixos/modules/services/matrix/conduit.nix
View file

@ -23,8 +23,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.matrix-conduit; default = pkgs.matrix-conduit;
defaultText = "pkgs.matrix-conduit"; defaultText = lib.literalExpression "pkgs.matrix-conduit";
example = "pkgs.matrix-conduit";
description = lib.mdDoc '' description = lib.mdDoc ''
Package of the conduit matrix server to use. Package of the conduit matrix server to use.
''; '';

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

@ -286,6 +286,7 @@ in {
log_config = mkOption { log_config = mkOption {
type = types.path; type = types.path;
default = ./synapse-log_config.yaml; default = ./synapse-log_config.yaml;
defaultText = lib.literalExpression "nixos/modules/services/matrix/synapse-log_config.yaml";
description = lib.mdDoc '' description = lib.mdDoc ''
The file that holds the logging configuration. The file that holds the logging configuration.
''; '';

4
nixos/modules/services/misc/autorandr.nix
View file

@ -258,7 +258,7 @@ in {
type = hooksModule; type = hooksModule;
description = lib.mdDoc "Global hook scripts"; description = lib.mdDoc "Global hook scripts";
default = { }; default = { };
example = '' example = literalExpression ''
{ {
postswitch = { postswitch = {
"notify-i3" = "''${pkgs.i3}/bin/i3-msg restart"; "notify-i3" = "''${pkgs.i3}/bin/i3-msg restart";
@ -279,7 +279,7 @@ in {
exit 1 exit 1
esac esac
echo "Xft.dpi: $DPI" | ''${pkgs.xorg.xrdb}/bin/xrdb -merge echo "Xft.dpi: $DPI" | ''${pkgs.xorg.xrdb}/bin/xrdb -merge
''' ''';
}; };
} }
''; '';

3
nixos/modules/services/misc/heisenbridge.nix
View file

@ -28,8 +28,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.heisenbridge; default = pkgs.heisenbridge;
defaultText = "pkgs.heisenbridge"; defaultText = lib.literalExpression "pkgs.heisenbridge";
example = "pkgs.heisenbridge.override { … = …; }";
description = lib.mdDoc '' description = lib.mdDoc ''
Package of the application to run, exposed for overriding purposes. Package of the application to run, exposed for overriding purposes.
''; '';

4
nixos/modules/services/misc/portunus.nix
View file

@ -29,7 +29,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.portunus; default = pkgs.portunus;
defaultText = "pkgs.portunus"; defaultText = lib.literalExpression "pkgs.portunus";
description = lib.mdDoc "The Portunus package to use."; description = lib.mdDoc "The Portunus package to use.";
}; };
@ -108,7 +108,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.openldap; default = pkgs.openldap;
defaultText = "pkgs.openldap"; defaultText = lib.literalExpression "pkgs.openldap";
description = lib.mdDoc "The OpenLDAP package to use."; description = lib.mdDoc "The OpenLDAP package to use.";
}; };

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

@ -505,7 +505,7 @@ in
description = lib.mdDoc "Origin URL for API, 100 more than web."; description = lib.mdDoc "Origin URL for API, 100 more than web.";
type = types.str; type = types.str;
default = "http://${cfg.listenAddress}:${toString (cfg.meta.port + 100)}"; 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)}''; defaultText = lib.literalMD ''`"http://''${`[](#opt-services.sourcehut.listenAddress)`}:''${toString (`[](#opt-services.sourcehut.meta.port)` + 100)}"`'';
}; };
webhooks = mkOption { webhooks = mkOption {
description = lib.mdDoc "The Redis connection used for the webhooks worker."; description = lib.mdDoc "The Redis connection used for the webhooks worker.";

26
nixos/modules/services/monitoring/grafana-agent.nix
View file

@ -16,7 +16,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.grafana-agent; default = pkgs.grafana-agent;
defaultText = "pkgs.grafana-agent"; defaultText = lib.literalExpression "pkgs.grafana-agent";
description = lib.mdDoc "The grafana-agent package to use."; description = lib.mdDoc "The grafana-agent package to use.";
}; };
@ -49,17 +49,19 @@ in
}; };
default = { }; default = { };
defaultText = '' defaultText = lib.literalExpression ''
metrics = { {
wal_directory = "\''${STATE_DIRECTORY}"; metrics = {
global.scrape_interval = "5s"; wal_directory = "\''${STATE_DIRECTORY}";
}; global.scrape_interval = "5s";
integrations = { };
agent.enabled = true; integrations = {
agent.scrape_integration = true; agent.enabled = true;
node_exporter.enabled = true; agent.scrape_integration = true;
replace_instance_label = true; node_exporter.enabled = true;
}; replace_instance_label = true;
};
}
''; '';
example = { example = {
metrics.global.remote_write = [{ metrics.global.remote_write = [{

3
nixos/modules/services/monitoring/uptime-kuma.nix
View file

@ -13,9 +13,8 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
example = literalExpression "pkgs.uptime-kuma";
default = pkgs.uptime-kuma; default = pkgs.uptime-kuma;
defaultText = "pkgs.uptime-kuma"; defaultText = literalExpression "pkgs.uptime-kuma";
description = lib.mdDoc "Uptime Kuma package to use."; description = lib.mdDoc "Uptime Kuma package to use.";
}; };

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

@ -71,7 +71,7 @@ with lib;
package = mkOption { package = mkOption {
type = package; type = package;
default = pkgs.ddclient; default = pkgs.ddclient;
defaultText = "pkgs.ddclient"; defaultText = lib.literalExpression "pkgs.ddclient";
description = lib.mdDoc '' description = lib.mdDoc ''
The ddclient executable package run by the service. The ddclient executable package run by the service.
''; '';

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

@ -17,10 +17,10 @@ in {
configFile = lib.mkOption { configFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
default = (pkgs.formats.yaml {}).generate "ergo.conf" cfg.settings; default = (pkgs.formats.yaml {}).generate "ergo.conf" cfg.settings;
defaultText = "generated config file from <literal>.settings</literal>"; defaultText = lib.literalMD "generated config file from `settings`";
description = lib.mdDoc '' description = lib.mdDoc ''
Path to configuration file. Path to configuration file.
Setting this will skip any configuration done via `.settings` Setting this will skip any configuration done via `settings`
''; '';
}; };

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

@ -28,7 +28,7 @@ in {
type = package; type = package;
description = lib.mdDoc "multipath-tools package to use"; description = lib.mdDoc "multipath-tools package to use";
default = pkgs.multipath-tools; default = pkgs.multipath-tools;
defaultText = "pkgs.multipath-tools"; defaultText = lib.literalExpression "pkgs.multipath-tools";
}; };
devices = mkOption { devices = mkOption {

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

@ -67,7 +67,7 @@ in
Additional plugins dir used to configure nomad. Additional plugins dir used to configure nomad.
''; '';
example = literalExpression '' example = literalExpression ''
[ "<pluginDir>" "pkgs.<plugins-name>"] [ "<pluginDir>" pkgs.<plugins-name> ]
''; '';
}; };

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

@ -20,7 +20,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.sabnzbd; default = pkgs.sabnzbd;
defaultText = "pkgs.sabnzbd"; defaultText = lib.literalExpression "pkgs.sabnzbd";
description = lib.mdDoc "The sabnzbd executable package run by the service."; description = lib.mdDoc "The sabnzbd executable package run by the service.";
}; };

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

@ -21,7 +21,7 @@ in
package = mkOption { 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."; 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; default = pkgs.meilisearch;
defaultText = "pkgs.meilisearch"; defaultText = lib.literalExpression "pkgs.meilisearch";
type = types.package; type = types.package;
}; };

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

@ -91,7 +91,7 @@ in {
InterceptUnknown = mkOption { InterceptUnknown = mkOption {
type = types.bool; type = types.bool;
description = mdDoc '' description = mdDoc ''
Wheter to intercept spare connections. Whether to intercept spare connections.
''; '';
}; };

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

@ -15,7 +15,7 @@ in {
package = mkOption { package = mkOption {
default = pkgs.code-server; default = pkgs.code-server;
defaultText = "pkgs.code-server"; defaultText = lib.literalExpression "pkgs.code-server";
description = lib.mdDoc "Which code-server derivation to use."; description = lib.mdDoc "Which code-server derivation to use.";
type = types.package; type = types.package;
}; };

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

@ -151,7 +151,7 @@ in
package = lib.mkOption { package = lib.mkOption {
type = types.package; type = types.package;
default = pkgs.invidious; default = pkgs.invidious;
defaultText = "pkgs.invidious"; defaultText = lib.literalExpression "pkgs.invidious";
description = lib.mdDoc "The Invidious package to use."; description = lib.mdDoc "The Invidious package to use.";
}; };

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

@ -106,7 +106,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.mattermost; default = pkgs.mattermost;
defaultText = "pkgs.mattermost"; defaultText = lib.literalExpression "pkgs.mattermost";
description = lib.mdDoc "Mattermost derivation to use."; description = lib.mdDoc "Mattermost derivation to use.";
}; };
@ -238,7 +238,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.matterircd; default = pkgs.matterircd;
defaultText = "pkgs.matterircd"; defaultText = lib.literalExpression "pkgs.matterircd";
description = lib.mdDoc "matterircd derivation to use."; description = lib.mdDoc "matterircd derivation to use.";
}; };
parameters = mkOption { parameters = mkOption {

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

@ -29,7 +29,7 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.onlyoffice-documentserver; default = pkgs.onlyoffice-documentserver;
defaultText = "pkgs.onlyoffice-documentserver"; defaultText = lib.literalExpression "pkgs.onlyoffice-documentserver";
description = lib.mdDoc "Which package to use for the OnlyOffice instance."; description = lib.mdDoc "Which package to use for the OnlyOffice instance.";
}; };

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

@ -137,7 +137,7 @@ in
package = mkOption { package = mkOption {
default = pkgs.lighttpd; default = pkgs.lighttpd;
defaultText = "pkgs.lighttpd"; defaultText = lib.literalExpression "pkgs.lighttpd";
type = types.package; type = types.package;
description = lib.mdDoc '' description = lib.mdDoc ''
lighttpd package to use. lighttpd package to use.

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

@ -580,7 +580,7 @@ in
virtualisation.host.pkgs = mkOption { virtualisation.host.pkgs = mkOption {
type = options.nixpkgs.pkgs.type; type = options.nixpkgs.pkgs.type;
default = pkgs; default = pkgs;
defaultText = "pkgs"; defaultText = literalExpression "pkgs";
example = literalExpression '' example = literalExpression ''
import pkgs.path { system = "x86_64-darwin"; } import pkgs.path { system = "x86_64-darwin"; }
''; '';
@ -595,7 +595,8 @@ in
mkOption { mkOption {
type = types.package; type = types.package;
default = cfg.host.pkgs.qemu_kvm; default = cfg.host.pkgs.qemu_kvm;
example = "pkgs.qemu_test"; defaultText = literalExpression "config.virtualisation.host.pkgs.qemu_kvm";
example = literalExpression "pkgs.qemu_test";
description = lib.mdDoc "QEMU package to use."; description = lib.mdDoc "QEMU package to use.";
}; };
@ -721,7 +722,7 @@ in
firmware = mkOption { firmware = mkOption {
type = types.path; type = types.path;
default = pkgs.OVMF.firmware; default = pkgs.OVMF.firmware;
defaultText = "pkgs.OVMF.firmware"; defaultText = literalExpression "pkgs.OVMF.firmware";
description = description =
lib.mdDoc '' lib.mdDoc ''
Firmware binary for EFI implementation, defaults to OVMF. Firmware binary for EFI implementation, defaults to OVMF.
@ -731,7 +732,7 @@ in
variables = mkOption { variables = mkOption {
type = types.path; type = types.path;
default = pkgs.OVMF.variables; default = pkgs.OVMF.variables;
defaultText = "pkgs.OVMF.variables"; defaultText = literalExpression "pkgs.OVMF.variables";
description = description =
lib.mdDoc '' lib.mdDoc ''
Platform-specific flash binary for EFI variables, implementation-dependent to the EFI firmware. Platform-specific flash binary for EFI variables, implementation-dependent to the EFI firmware.