diff options
author | pennae <github@quasiparticle.net> | 2022-08-29 19:19:32 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-31 16:21:14 +0200 |
commit | 5841c386a0ce5fc02b1d32a2e423e81923c32052 (patch) | |
tree | 0da4bec3b93ce7df752dc227c6e53fea30231bbb /nixos/modules/services/torrent/transmission.nix | |
parent | 9c3c13b50d02380cda1c834bc15cff3346956ea4 (diff) | |
download | nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar.gz nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar.bz2 nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar.lz nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar.xz nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.tar.zst nixpkgs-5841c386a0ce5fc02b1d32a2e423e81923c32052.zip |
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.
Diffstat (limited to 'nixos/modules/services/torrent/transmission.nix')
-rw-r--r-- | nixos/modules/services/torrent/transmission.nix | 34 |
1 files changed, 21 insertions, 13 deletions
diff --git a/nixos/modules/services/torrent/transmission.nix b/nixos/modules/services/torrent/transmission.nix index 6a038dc0a32..08abd86b4ec 100644 --- a/nixos/modules/services/torrent/transmission.nix +++ b/nixos/modules/services/torrent/transmission.nix @@ -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. + ''; + }; }; }; |