movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 06:00:33 +03:00
Code Activity

nixos: fix bad mkEnableOption descriptions

Browse source 
Fix descriptions that don't account for (1) the "Whether to enable"
prefix or (2) the automatically added trailing dot.
This commit is contained in:
Bjørn Forsman 2023-10-18 22:59:26 +02:00 • committed by Jörg Thalheim
parent ccf848f9dd
commit 142074c2a8
72 changed files with 121 additions and 121 deletions
Download patch file Download diff file Expand all files Collapse all files

20
nixos/modules/services/backup/znapzend.nix
View file

@ -359,14 +359,14 @@ in
};
features.oracleMode = mkEnableOption (lib.mdDoc ''
Destroy snapshots one by one instead of using one long argument list.
destroying snapshots one by one instead of using one long argument list.
If source and destination are out of sync for a long time, you may have
so many snapshots to destroy that the argument gets is too long and the
command fails.
command fails
'');
features.recvu = mkEnableOption (lib.mdDoc ''
recvu feature which uses `-u` on the receiving end to keep the destination
filesystem unmounted.
filesystem unmounted
'');
features.compressed = mkEnableOption (lib.mdDoc ''
compressed feature which adds the options `-Lce` to
@ -377,7 +377,7 @@ in
support and -e is for embedded data support. see
{manpage}`znapzend(1)`
and {manpage}`zfs(8)`
for more info.
for more info
'');
features.sendRaw = mkEnableOption (lib.mdDoc ''
sendRaw feature which adds the options `-w` to the
@ -386,25 +386,25 @@ in
backup that can't be read without the encryption key/passphrase, useful
when the remote isn't fully trusted or not physically secure. This
option must be used consistently, raw incrementals cannot be based on
non-raw snapshots and vice versa.
non-raw snapshots and vice versa
'');
features.skipIntermediates = mkEnableOption (lib.mdDoc ''
Enable the skipIntermediates feature to send a single increment
the skipIntermediates feature to send a single increment
between latest common snapshot and the newly made one. It may skip
several source snaps if the destination was offline for some time, and
it should skip snapshots not managed by znapzend. Normally for online
destinations, the new snapshot is sent as soon as it is created on the
source, so there are no automatic increments to skip.
source, so there are no automatic increments to skip
'');
features.lowmemRecurse = mkEnableOption (lib.mdDoc ''
use lowmemRecurse on systems where you have too many datasets, so a
recursive listing of attributes to find backup plans exhausts the
memory available to {command}`znapzend`: instead, go the slower
way to first list all impacted dataset names, and then query their
configs one by one.
configs one by one
'');
features.zfsGetType = mkEnableOption (lib.mdDoc ''
use zfsGetType if your {command}`zfs get` supports a
using zfsGetType if your {command}`zfs get` supports a
`-t` argument for filtering by dataset type at all AND
lists properties for snapshots by default when recursing, so that there
is too much data to process while searching for backup plans.
@ -412,7 +412,7 @@ in
`--recursive` search for backup plans can literally
differ by hundreds of times (depending on the amount of snapshots in
that dataset tree... and a decent backup plan will ensure you have a lot
of those), so you would benefit from requesting this feature.
of those), so you would benefit from requesting this feature
'');
};
};