about summary refs log tree commit diff
path: root/nixos/modules/services/backup/bacula.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/bacula.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/bacula.nix')
-rw-r--r--nixos/modules/services/backup/bacula.nix83
1 files changed, 41 insertions, 42 deletions
diff --git a/nixos/modules/services/backup/bacula.nix b/nixos/modules/services/backup/bacula.nix
index 39975adf59092..94f6e6ba4fd58 100644
--- a/nixos/modules/services/backup/bacula.nix
+++ b/nixos/modules/services/backup/bacula.nix
@@ -10,7 +10,6 @@ let
     concatStringsSep
     literalExpression
     mapAttrsToList
-    mdDoc
     mkIf
     mkOption
     optional
@@ -147,7 +146,7 @@ let
       enable = mkOption {
         type = types.bool;
         default = false;
-        description = mdDoc ''
+        description = ''
           Specifies if TLS should be enabled.
           If this set to `false` TLS will be completely disabled, even if ${tlsLink "tls.require" submodulePath} is true.
         '';
@@ -155,7 +154,7 @@ let
       require = mkOption {
         type = types.nullOr types.bool;
         default = null;
-        description = mdDoc ''
+        description = ''
           Require TLS or TLS-PSK encryption.
           This directive is ignored unless one of ${tlsLink "tls.enable" submodulePath} is true or TLS PSK Enable is set to `yes`.
           If TLS is not required while TLS or TLS-PSK are enabled, then the Bacula component
@@ -168,7 +167,7 @@ let
       certificate = mkOption {
         type = types.nullOr types.path;
         default = null;
-        description = mdDoc ''
+        description = ''
           The full path to the PEM encoded TLS certificate.
           It will be used as either a client or server certificate,
           depending on the connection direction.
@@ -179,7 +178,7 @@ let
       };
       key = mkOption {
         type = types.path;
-        description = mdDoc ''
+        description = ''
           The path of a PEM encoded TLS private key.
           It must correspond to the TLS certificate.
         '';
@@ -187,7 +186,7 @@ let
       verifyPeer = mkOption {
         type = types.nullOr types.bool;
         default = null;
-        description = mdDoc ''
+        description = ''
           Verify peer certificate.
           Instructs server to request and verify the client's X.509 certificate.
           Any client certificate signed by a known-CA will be accepted.
@@ -203,7 +202,7 @@ let
       allowedCN = mkOption {
         type = types.listOf types.str;
         default = [ ];
-        description = mdDoc ''
+        description = ''
           Common name attribute of allowed peer certificates.
           This directive is valid for a server and in a client context.
           If this directive is specified, the peer certificate will be verified against this list.
@@ -214,7 +213,7 @@ let
       caCertificateFile = mkOption {
         type = types.nullOr types.path;
         default = null;
-        description = mdDoc ''
+        description = ''
           The path specifying a PEM encoded TLS CA certificate(s).
           Multiple certificates are permitted in the file.
           One of TLS CA Certificate File or TLS CA Certificate Dir are required in a server context, unless
@@ -230,7 +229,7 @@ let
       password = mkOption {
         type = types.str;
         # TODO: required?
-        description = mdDoc ''
+        description = ''
           Specifies the password that must be supplied for the default Bacula
           Console to be authorized. The same password must appear in the
           Director resource of the Console configuration file. For added
@@ -251,7 +250,7 @@ let
         type = types.enum [ "no" "yes" ];
         default = "no";
         example = "yes";
-        description = mdDoc ''
+        description = ''
           If Monitor is set to `no`, this director will have
           full access to this Storage daemon. If Monitor is set to
           `yes`, this director will only be able to fetch the
@@ -265,7 +264,7 @@ let
 
       tls = mkOption {
         type = types.submodule (tlsOptions "${submodulePath}.director.<name>");
-        description = mdDoc ''
+        description = ''
           TLS Options for the Director in this Configuration.
         '';
       };
@@ -277,7 +276,7 @@ let
     options = {
       changerDevice = mkOption {
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The specified name-string must be the generic SCSI device name of the
           autochanger that corresponds to the normal read/write Archive Device
           specified in the Device resource. This generic SCSI device name
@@ -296,7 +295,7 @@ let
 
       changerCommand = mkOption {
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The name-string specifies an external program to be called that will
           automatically change volumes as required by Bacula. Normally, this
           directive will be specified only in the AutoChanger resource, which
@@ -318,14 +317,14 @@ let
       };
 
       devices = mkOption {
-        description = mdDoc "";
+        description = "";
         type = types.listOf types.str;
       };
 
       extraAutochangerConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Autochanger directive.
         '';
         example = ''
@@ -342,7 +341,7 @@ let
       archiveDevice = mkOption {
         # TODO: required?
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The specified name-string gives the system file name of the storage
           device managed by this storage daemon. This will usually be the
           device file name of a removable storage device (tape drive), for
@@ -359,7 +358,7 @@ let
       mediaType = mkOption {
         # TODO: required?
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The specified name-string names the type of media supported by this
           device, for example, `DLT7000`. Media type names are
           arbitrary in that you set them to anything you want, but they must be
@@ -397,7 +396,7 @@ let
       extraDeviceConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Device directive.
         '';
         example = ''
@@ -418,7 +417,7 @@ in {
       enable = mkOption {
         type = types.bool;
         default = false;
-        description = mdDoc ''
+        description = ''
           Whether to enable the Bacula File Daemon.
         '';
       };
@@ -427,7 +426,7 @@ in {
         default = "${config.networking.hostName}-fd";
         defaultText = literalExpression ''"''${config.networking.hostName}-fd"'';
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The client name that must be used by the Director when connecting.
           Generally, it is a good idea to use a name related to the machine so
           that error messages can be easily identified if you have multiple
@@ -438,7 +437,7 @@ in {
       port = mkOption {
         default = 9102;
         type = types.port;
-        description = mdDoc ''
+        description = ''
           This specifies the port number on which the Client listens for
           Director connections. It must agree with the FDPort specified in
           the Client resource of the Director's configuration file.
@@ -447,7 +446,7 @@ in {
 
       director = mkOption {
         default = {};
-        description = mdDoc ''
+        description = ''
           This option defines director resources in Bacula File Daemon.
         '';
         type = types.attrsOf (types.submodule (directorOptions "services.bacula-fd"));
@@ -457,7 +456,7 @@ in {
       tls = mkOption {
         type = types.submodule (tlsOptions "services.bacula-fd");
         default = { };
-        description = mdDoc ''
+        description = ''
           TLS Options for the File Daemon.
           Important notice: The backup won't be encrypted.
         '';
@@ -466,7 +465,7 @@ in {
       extraClientConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Client directive.
         '';
         example = ''
@@ -478,7 +477,7 @@ in {
       extraMessagesConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Messages directive.
         '';
         example = ''
@@ -491,7 +490,7 @@ in {
       enable = mkOption {
         type = types.bool;
         default = false;
-        description = mdDoc ''
+        description = ''
           Whether to enable Bacula Storage Daemon.
         '';
       };
@@ -500,7 +499,7 @@ in {
         default = "${config.networking.hostName}-sd";
         defaultText = literalExpression ''"''${config.networking.hostName}-sd"'';
         type = types.str;
-        description = mdDoc ''
+        description = ''
           Specifies the Name of the Storage daemon.
         '';
       };
@@ -508,7 +507,7 @@ in {
       port = mkOption {
         default = 9103;
         type = types.port;
-        description = mdDoc ''
+        description = ''
           Specifies port number on which the Storage daemon listens for
           Director connections.
         '';
@@ -516,7 +515,7 @@ in {
 
       director = mkOption {
         default = {};
-        description = mdDoc ''
+        description = ''
           This option defines Director resources in Bacula Storage Daemon.
         '';
         type = types.attrsOf (types.submodule (directorOptions "services.bacula-sd"));
@@ -524,7 +523,7 @@ in {
 
       device = mkOption {
         default = {};
-        description = mdDoc ''
+        description = ''
           This option defines Device resources in Bacula Storage Daemon.
         '';
         type = types.attrsOf (types.submodule deviceOptions);
@@ -532,7 +531,7 @@ in {
 
       autochanger = mkOption {
         default = {};
-        description = mdDoc ''
+        description = ''
           This option defines Autochanger resources in Bacula Storage Daemon.
         '';
         type = types.attrsOf (types.submodule autochangerOptions);
@@ -541,7 +540,7 @@ in {
       extraStorageConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Storage directive.
         '';
         example = ''
@@ -553,7 +552,7 @@ in {
       extraMessagesConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Messages directive.
         '';
         example = ''
@@ -563,7 +562,7 @@ in {
       tls = mkOption {
         type = types.submodule (tlsOptions "services.bacula-sd");
         default = { };
-        description = mdDoc ''
+        description = ''
           TLS Options for the Storage Daemon.
           Important notice: The backup won't be encrypted.
         '';
@@ -575,7 +574,7 @@ in {
       enable = mkOption {
         type = types.bool;
         default = false;
-        description = mdDoc ''
+        description = ''
           Whether to enable Bacula Director Daemon.
         '';
       };
@@ -584,7 +583,7 @@ in {
         default = "${config.networking.hostName}-dir";
         defaultText = literalExpression ''"''${config.networking.hostName}-dir"'';
         type = types.str;
-        description = mdDoc ''
+        description = ''
           The director name used by the system administrator. This directive is
           required.
         '';
@@ -593,7 +592,7 @@ in {
       port = mkOption {
         default = 9101;
         type = types.port;
-        description = mdDoc ''
+        description = ''
           Specify the port (a positive integer) on which the Director daemon
           will listen for Bacula Console connections. This same port number
           must be specified in the Director resource of the Console
@@ -606,7 +605,7 @@ in {
       password = mkOption {
         # TODO: required?
         type = types.str;
-        description = mdDoc ''
+        description = ''
            Specifies the password that must be supplied for a Director.
         '';
       };
@@ -614,7 +613,7 @@ in {
       extraMessagesConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Messages directive.
         '';
         example = ''
@@ -625,7 +624,7 @@ in {
       extraDirectorConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration to be passed in Director directive.
         '';
         example = ''
@@ -637,7 +636,7 @@ in {
       extraConfig = mkOption {
         default = "";
         type = types.lines;
-        description = mdDoc ''
+        description = ''
           Extra configuration for Bacula Director Daemon.
         '';
         example = ''
@@ -648,7 +647,7 @@ in {
       tls = mkOption {
         type = types.submodule (tlsOptions "services.bacula-dir");
         default = { };
-        description = mdDoc ''
+        description = ''
           TLS Options for the Director.
           Important notice: The backup won't be encrypted.
         '';