about summary refs log tree commit diff
path: root/nixos/modules/services/backup/tarsnap.nix
diff options
context:
space:
mode:
authorstuebinm <stuebinm@disroot.org>2024-04-13 14:54:15 +0200
committerJonathan Ringer <jonringer@users.noreply.github.com>2024-04-13 10:07:35 -0700
commit6afb255d976f85f3359e4929abd6f5149c323a02 (patch)
treeced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/services/backup/tarsnap.nix
parent1dd996e59a5e67694b7a252aacba71a88d51b41e (diff)
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/services/backup/tarsnap.nix')
-rw-r--r--nixos/modules/services/backup/tarsnap.nix42
1 files changed, 21 insertions, 21 deletions
diff --git a/nixos/modules/services/backup/tarsnap.nix b/nixos/modules/services/backup/tarsnap.nix
index 9e1db23ca22a7..b8f848451d40b 100644
--- a/nixos/modules/services/backup/tarsnap.nix
+++ b/nixos/modules/services/backup/tarsnap.nix
@@ -30,14 +30,14 @@ in
 
   options = {
     services.tarsnap = {
-      enable = mkEnableOption (lib.mdDoc "periodic tarsnap backups");
+      enable = mkEnableOption "periodic tarsnap backups";
 
       package = mkPackageOption pkgs "tarsnap" { };
 
       keyfile = mkOption {
         type = types.str;
         default = "/root/tarsnap.key";
-        description = lib.mdDoc ''
+        description = ''
           The keyfile which associates this machine with your tarsnap
           account.
           Create the keyfile with {command}`tarsnap-keygen`.
@@ -69,7 +69,7 @@ in
                 type = types.str;
                 default = gcfg.keyfile;
                 defaultText = literalExpression "config.${opt.keyfile}";
-                description = lib.mdDoc ''
+                description = ''
                   Set a specific keyfile for this archive. This defaults to
                   `"/root/tarsnap.key"` if left unspecified.
 
@@ -94,7 +94,7 @@ in
                 defaultText = literalExpression ''
                   "/var/cache/tarsnap/''${utils.escapeSystemdPath config.${options.keyfile}}"
                 '';
-                description = lib.mdDoc ''
+                description = ''
                   The cache allows tarsnap to identify previously stored data
                   blocks, reducing archival time and bandwidth usage.
 
@@ -109,7 +109,7 @@ in
               nodump = mkOption {
                 type = types.bool;
                 default = true;
-                description = lib.mdDoc ''
+                description = ''
                   Exclude files with the `nodump` flag.
                 '';
               };
@@ -117,7 +117,7 @@ in
               printStats = mkOption {
                 type = types.bool;
                 default = true;
-                description = lib.mdDoc ''
+                description = ''
                   Print global archive statistics upon completion.
                   The output is available via
                   {command}`systemctl status tarsnap-archive-name`.
@@ -127,7 +127,7 @@ in
               checkpointBytes = mkOption {
                 type = types.nullOr types.str;
                 default = "1GB";
-                description = lib.mdDoc ''
+                description = ''
                   Create a checkpoint every `checkpointBytes`
                   of uploaded data (optionally specified using an SI prefix).
 
@@ -142,7 +142,7 @@ in
                 type = types.str;
                 default = "01:15";
                 example = "hourly";
-                description = lib.mdDoc ''
+                description = ''
                   Create archive at this interval.
 
                   The format is described in
@@ -153,7 +153,7 @@ in
               aggressiveNetworking = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Upload data over multiple TCP connections, potentially
                   increasing tarsnap's bandwidth utilisation at the cost
                   of slowing down all other network traffic. Not
@@ -165,13 +165,13 @@ in
               directories = mkOption {
                 type = types.listOf types.path;
                 default = [];
-                description = lib.mdDoc "List of filesystem paths to archive.";
+                description = "List of filesystem paths to archive.";
               };
 
               excludes = mkOption {
                 type = types.listOf types.str;
                 default = [];
-                description = lib.mdDoc ''
+                description = ''
                   Exclude files and directories matching these patterns.
                 '';
               };
@@ -179,7 +179,7 @@ in
               includes = mkOption {
                 type = types.listOf types.str;
                 default = [];
-                description = lib.mdDoc ''
+                description = ''
                   Include only files and directories matching these
                   patterns (the empty list includes everything).
 
@@ -190,7 +190,7 @@ in
               lowmem = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Reduce memory consumption by not caching small files.
                   Possibly beneficial if the average file size is smaller
                   than 1 MB and the number of files is lower than the
@@ -201,7 +201,7 @@ in
               verylowmem = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Reduce memory consumption by a factor of 2 beyond what
                   `lowmem` does, at the cost of significantly
                   slowing down the archiving process.
@@ -211,7 +211,7 @@ in
               maxbw = mkOption {
                 type = types.nullOr types.int;
                 default = null;
-                description = lib.mdDoc ''
+                description = ''
                   Abort archival if upstream bandwidth usage in bytes
                   exceeds this threshold.
                 '';
@@ -221,7 +221,7 @@ in
                 type = types.nullOr types.int;
                 default = null;
                 example = literalExpression "25 * 1000";
-                description = lib.mdDoc ''
+                description = ''
                   Upload bandwidth rate limit in bytes.
                 '';
               };
@@ -230,7 +230,7 @@ in
                 type = types.nullOr types.int;
                 default = null;
                 example = literalExpression "50 * 1000";
-                description = lib.mdDoc ''
+                description = ''
                   Download bandwidth rate limit in bytes.
                 '';
               };
@@ -238,21 +238,21 @@ in
               verbose = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Whether to produce verbose logging output.
                 '';
               };
               explicitSymlinks = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Whether to follow symlinks specified as archives.
                 '';
               };
               followSymlinks = mkOption {
                 type = types.bool;
                 default = false;
-                description = lib.mdDoc ''
+                description = ''
                   Whether to follow all symlinks in archive trees.
                 '';
               };
@@ -275,7 +275,7 @@ in
           }
         '';
 
-        description = lib.mdDoc ''
+        description = ''
           Tarsnap archive configurations. Each attribute names an archive
           to be created at a given time interval, according to the options
           associated with it. When uploading to the tarsnap server,