nixos/*: remove indentation from long enable options
the way these are written they introduce lots of whitespace in each line, which will cause those lines to render as code when converted to markdown. override the whole description instead.
This commit is contained in:
parent
9c3c13b50d
commit
5841c386a0
|
@ -288,16 +288,20 @@ in
|
|||
};
|
||||
|
||||
relay = {
|
||||
enable = mkEnableOption ''relaying of Tor traffic for others.
|
||||
enable = mkEnableOption "tor relaying" // {
|
||||
description = ''
|
||||
Whether to enable relaying of Tor traffic for others.
|
||||
|
||||
See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay"/>
|
||||
for details.
|
||||
See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay"/>
|
||||
for details.
|
||||
|
||||
Setting this to true requires setting
|
||||
<option>services.tor.relay.role</option>
|
||||
and
|
||||
<option>services.tor.settings.ORPort</option>
|
||||
options'';
|
||||
Setting this to true requires setting
|
||||
<option>services.tor.relay.role</option>
|
||||
and
|
||||
<option>services.tor.settings.ORPort</option>
|
||||
options.
|
||||
'';
|
||||
};
|
||||
|
||||
role = mkOption {
|
||||
type = types.enum [ "exit" "relay" "bridge" "private-bridge" ];
|
||||
|
|
|
@ -24,14 +24,18 @@ in
|
|||
];
|
||||
options = {
|
||||
services.transmission = {
|
||||
enable = mkEnableOption ''the headless Transmission BitTorrent daemon.
|
||||
enable = mkEnableOption "transmission" // {
|
||||
description = ''
|
||||
Whether to enable the headless Transmission BitTorrent daemon.
|
||||
|
||||
Transmission daemon can be controlled via the RPC interface using
|
||||
transmission-remote, the WebUI (http://127.0.0.1:9091/ by default),
|
||||
or other clients like stig or tremc.
|
||||
Transmission daemon can be controlled via the RPC interface using
|
||||
transmission-remote, the WebUI (http://127.0.0.1:9091/ by default),
|
||||
or other clients like stig or tremc.
|
||||
|
||||
Torrents are downloaded to <xref linkend="opt-services.transmission.home"/>/${downloadsDir} by default and are
|
||||
accessible to users in the "transmission" group'';
|
||||
Torrents are downloaded to <xref linkend="opt-services.transmission.home"/>/${downloadsDir} by default and are
|
||||
accessible to users in the "transmission" group.
|
||||
'';
|
||||
};
|
||||
|
||||
settings = mkOption {
|
||||
description = lib.mdDoc ''
|
||||
|
@ -233,14 +237,18 @@ in
|
|||
|
||||
openRPCPort = mkEnableOption "opening of the RPC port in the firewall";
|
||||
|
||||
performanceNetParameters = mkEnableOption ''tweaking of kernel parameters
|
||||
to open many more connections at the same time.
|
||||
performanceNetParameters = mkEnableOption "performance tweaks" // {
|
||||
description = ''
|
||||
Whether to enable tweaking of kernel parameters
|
||||
to open many more connections at the same time.
|
||||
|
||||
Note that you may also want to increase
|
||||
<literal>peer-limit-global"</literal>.
|
||||
And be aware that these settings are quite aggressive
|
||||
and might not suite your regular desktop use.
|
||||
For instance, SSH sessions may time out more easily'';
|
||||
Note that you may also want to increase
|
||||
<literal>peer-limit-global"</literal>.
|
||||
And be aware that these settings are quite aggressive
|
||||
and might not suite your regular desktop use.
|
||||
For instance, SSH sessions may time out more easily.
|
||||
'';
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
|
|
|
@ -132,12 +132,15 @@ let
|
|||
|
||||
in {
|
||||
options.boot.initrd.systemd = {
|
||||
enable = mkEnableOption ''systemd in initrd.
|
||||
enable = mkEnableOption "systemd in initrd" // {
|
||||
description = ''
|
||||
Whether to enable systemd in initrd.
|
||||
|
||||
Note: This is in very early development and is highly
|
||||
experimental. Most of the features NixOS supports in initrd are
|
||||
not yet supported by the intrd generated with this option.
|
||||
'';
|
||||
Note: This is in very early development and is highly
|
||||
experimental. Most of the features NixOS supports in initrd are
|
||||
not yet supported by the intrd generated with this option.
|
||||
'';
|
||||
};
|
||||
|
||||
package = (mkPackageOption pkgs "systemd" {
|
||||
default = "systemdStage1";
|
||||
|
|
Loading…
Reference in a new issue