diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/bees.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/misc/bees.nix | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/bees.nix b/nixpkgs/nixos/modules/services/misc/bees.nix index fa00d7e4f55d..37f90c682221 100644 --- a/nixpkgs/nixos/modules/services/misc/bees.nix +++ b/nixpkgs/nixos/modules/services/misc/bees.nix @@ -11,14 +11,13 @@ let fsOptions = with types; { options.spec = mkOption { type = str; - description = '' + description = lib.mdDoc '' Description of how to identify the filesystem to be duplicated by this instance of bees. Note that deduplication crosses subvolumes; one must not configure multiple instances for subvolumes of the same filesystem (or block devices which are part of the same filesystem), but only for completely independent btrfs filesystems. - </para> - <para> + This must be in a format usable by findmnt; that could be a key=value pair, or a bare path to a mount point. Using bare paths will allow systemd to start the beesd service only @@ -29,14 +28,12 @@ let options.hashTableSizeMB = mkOption { type = types.addCheck types.int (n: mod n 16 == 0); default = 1024; # 1GB; default from upstream beesd script - description = '' + description = lib.mdDoc '' Hash table size in MB; must be a multiple of 16. - </para> - <para> + A larger ratio of index size to storage size means smaller blocks of duplicate content are recognized. - </para> - <para> + If you have 1TB of data, a 4GB hash table (which is to say, a value of 4096) will permit 4KB extents (the smallest possible size) to be recognized, whereas a value of 1024 -- creating a 1GB hash table -- @@ -47,12 +44,12 @@ let type = types.enum (attrNames logLevels ++ attrValues logLevels); apply = v: if isString v then logLevels.${v} else v; default = "info"; - description = "Log verbosity (syslog keyword/level)."; + description = lib.mdDoc "Log verbosity (syslog keyword/level)."; }; options.workDir = mkOption { type = str; default = ".beeshome"; - description = '' + description = lib.mdDoc '' Name (relative to the root of the filesystem) of the subvolume where the hash table will be stored. ''; @@ -60,7 +57,7 @@ let options.extraOptions = mkOption { type = listOf str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra command-line options passed to the daemon. See upstream bees documentation. ''; example = literalExpression '' @@ -75,7 +72,7 @@ in options.services.beesd = { filesystems = mkOption { type = with types; attrsOf (submodule fsOptions); - description = "BTRFS filesystems to run block-level deduplication on."; + description = lib.mdDoc "BTRFS filesystems to run block-level deduplication on."; default = { }; example = literalExpression '' { |