From e4ed177f828337062662983e15434525dd168c7d Mon Sep 17 00:00:00 2001 From: pennae Date: Sat, 13 Aug 2022 11:35:46 +0200 Subject: [PATCH] nixos/* eliminate inner whitespace in tags that was missed earlier nix-doc-munge won't match tags that contain newlines anywhere. most of these have already been removed, but a few obviously made it through. --- nixos/modules/config/krb5/default.nix | 4 ++-- nixos/modules/security/pam.nix | 3 +-- nixos/modules/services/matrix/dendrite.nix | 3 +-- nixos/modules/services/misc/gitolite.nix | 3 +-- nixos/modules/services/monitoring/prometheus/default.nix | 3 +-- nixos/modules/services/networking/resilio.nix | 4 ++-- nixos/modules/services/networking/yggdrasil.nix | 5 ++--- nixos/modules/services/torrent/magnetico.nix | 4 ++-- nixos/modules/system/activation/activation-script.nix | 4 ++-- nixos/modules/system/boot/luksroot.nix | 4 ++-- nixos/modules/tasks/auto-upgrade.nix | 4 ++-- nixos/modules/tasks/filesystems.nix | 3 +-- nixos/modules/virtualisation/lxc.nix | 3 +-- 13 files changed, 20 insertions(+), 27 deletions(-) diff --git a/nixos/modules/config/krb5/default.nix b/nixos/modules/config/krb5/default.nix index 6cc30c47b7de..db5321f176c8 100644 --- a/nixos/modules/config/krb5/default.nix +++ b/nixos/modules/config/krb5/default.nix @@ -207,8 +207,8 @@ in { description = '' These lines go to the end of krb5.conf verbatim. krb5.conf may include any of the relations that are - valid for kdc.conf (see man - kdc.conf), but it is not a recommended practice. + valid for kdc.conf (see man kdc.conf), + but it is not a recommended practice. ''; }; diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 9f89508bd1fe..fefa303603dd 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -323,8 +323,7 @@ let description = '' Attribute set describing resource limits. Defaults to the value of . - The meaning of the values is explained in - limits.conf5. + The meaning of the values is explained in limits.conf5. ''; }; diff --git a/nixos/modules/services/matrix/dendrite.nix b/nixos/modules/services/matrix/dendrite.nix index 7cf9fd9e75f3..ecb7c4876e13 100644 --- a/nixos/modules/services/matrix/dendrite.nix +++ b/nixos/modules/services/matrix/dendrite.nix @@ -51,8 +51,7 @@ in example = "/var/lib/dendrite/registration_secret"; default = null; description = '' - Environment file as defined in - systemd.exec5. + Environment file as defined in systemd.exec5. Secrets may be passed to the service without adding them to the world-readable Nix store, by specifying placeholder variables as the option value in Nix and setting these variables accordingly in the environment file. Currently only used diff --git a/nixos/modules/services/misc/gitolite.nix b/nixos/modules/services/misc/gitolite.nix index b313be074db0..7de0e4f4897c 100644 --- a/nixos/modules/services/misc/gitolite.nix +++ b/nixos/modules/services/misc/gitolite.nix @@ -18,8 +18,7 @@ in Enable gitolite management under the gitolite user. After switching to a configuration with Gitolite enabled, you can - then run git clone - gitolite@host:gitolite-admin.git to manage it further. + then run git clone gitolite@host:gitolite-admin.git to manage it further. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index 3bc61fba158f..ce7455425a63 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -1730,8 +1730,7 @@ in default = true; example = "syntax-only"; description = '' - Check configuration with promtool - check. The call to promtool is + Check configuration with promtool check. The call to promtool is subject to sandboxing by Nix. If you use credentials stored in external files diff --git a/nixos/modules/services/networking/resilio.nix b/nixos/modules/services/networking/resilio.nix index 05798a2c83ee..eca5f5ccfe93 100644 --- a/nixos/modules/services/networking/resilio.nix +++ b/nixos/modules/services/networking/resilio.nix @@ -201,8 +201,8 @@ in ]; description = '' Shared folder list. If enabled, web UI must be - disabled. Secrets can be generated using rslsync - --generate-secret. Note that this secret will be + disabled. Secrets can be generated using rslsync --generate-secret. + Note that this secret will be put inside the Nix store, so it is realistically not very secret. diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index 81ed6d1dd566..d29ec55807bd 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -51,9 +51,8 @@ in { are supplied, they will be combined, with values from taking precedence. - You can use the command nix-shell -p yggdrasil --run - "yggdrasil -genconf" to generate default - configuration values with documentation. + You can use the command nix-shell -p yggdrasil --run "yggdrasil -genconf" + to generate default configuration values with documentation. ''; }; diff --git a/nixos/modules/services/torrent/magnetico.nix b/nixos/modules/services/torrent/magnetico.nix index c7255eba0565..ffc8577375b7 100644 --- a/nixos/modules/services/torrent/magnetico.nix +++ b/nixos/modules/services/torrent/magnetico.nix @@ -125,8 +125,8 @@ in { contain non-consecutive underscores except at the end, and consists of small-case a-z characters and digits 0-9. The htpasswd tool from the apacheHttpd - package may be used to generate the hash: htpasswd - -bnBC 12 username password + package may be used to generate the hash: + htpasswd -bnBC 12 username password diff --git a/nixos/modules/system/activation/activation-script.nix b/nixos/modules/system/activation/activation-script.nix index 88b3ac1d18e8..3a57642a53ee 100644 --- a/nixos/modules/system/activation/activation-script.nix +++ b/nixos/modules/system/activation/activation-script.nix @@ -92,8 +92,8 @@ let Whether this activation script supports being dry-activated. These activation scripts will also be executed on dry-activate activations with the environment variable - NIXOS_ACTION being set to dry-activate - . it's important that these activation scripts don't + NIXOS_ACTION being set to dry-activate. + it's important that these activation scripts don't modify anything about the system when the variable is set. ''; }; diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index 78301a57bd97..899f7df51e45 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -539,8 +539,8 @@ in Useful for mounting a number of devices that use the same passphrase without retyping it several times. - Such setup can be useful if you use cryptsetup - luksSuspend. Different LUKS devices will still have + Such setup can be useful if you use cryptsetup luksSuspend. + Different LUKS devices will still have different master keys even when using the same passphrase. ''; }; diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix index bfc5265518d2..309790eb0ed8 100644 --- a/nixos/modules/tasks/auto-upgrade.nix +++ b/nixos/modules/tasks/auto-upgrade.nix @@ -49,8 +49,8 @@ in { description = '' The URI of the NixOS channel to use for automatic upgrades. By default, this is the channel set using - nix-channel (run nix-channel - --list to see the current value). + nix-channel (run nix-channel --list + to see the current value). ''; }; diff --git a/nixos/modules/tasks/filesystems.nix b/nixos/modules/tasks/filesystems.nix index 318740a44f4a..cf9429f76b4c 100644 --- a/nixos/modules/tasks/filesystems.nix +++ b/nixos/modules/tasks/filesystems.nix @@ -188,8 +188,7 @@ in Instead of specifying device, you can also specify a volume label (label) for file - systems that support it, such as ext2/ext3 (see mke2fs - -L). + systems that support it, such as ext2/ext3 (see mke2fs -L). ''; }; diff --git a/nixos/modules/virtualisation/lxc.nix b/nixos/modules/virtualisation/lxc.nix index d7bbc3f8414c..2ae392ef931b 100644 --- a/nixos/modules/virtualisation/lxc.nix +++ b/nixos/modules/virtualisation/lxc.nix @@ -55,8 +55,7 @@ in description = '' This is the config file for managing unprivileged user network - administration access in LXC. See lxc-usernet5 - . + administration access in LXC. See lxc-usernet5. ''; }; };