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: remove all uses of lib.mdDoc

Browse source 
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.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 • committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions
Download patch file Download diff file Expand all files Collapse all files

42
nixos/modules/services/backup/syncoid.nix
View file

@ -85,7 +85,7 @@ in
# Interface
options.services.syncoid = {
enable = mkEnableOption (lib.mdDoc "Syncoid ZFS synchronization service");
enable = mkEnableOption "Syncoid ZFS synchronization service";
package = lib.mkPackageOption pkgs "sanoid" {};
@ -93,7 +93,7 @@ in
type = types.str;
default = "hourly";
example = "*-*-* *:15:00";
description = lib.mdDoc ''
description = ''
Run syncoid at this interval. The default is to run hourly.
The format is described in
@ -105,7 +105,7 @@ in
type = types.str;
default = "syncoid";
example = "backup";
description = lib.mdDoc ''
description = ''
The user for the service. ZFS privilege delegation will be
automatically configured for any local pools used by syncoid if this
option is set to a user other than root. The user will be given the
@ -119,13 +119,13 @@ in
type = types.str;
default = "syncoid";
example = "backup";
description = lib.mdDoc "The group for the service.";
description = "The group for the service.";
};
sshKey = mkOption {
type = with types; nullOr (coercedTo path toString str);
default = null;
description = lib.mdDoc ''
description = ''
SSH private key file to use to login to the remote system. Can be
overridden in individual commands.
'';
@ -135,7 +135,7 @@ in
type = types.listOf types.str;
# Permissions snapshot and destroy are in case --no-sync-snap is not used
default = [ "bookmark" "hold" "send" "snapshot" "destroy" "mount" ];
description = lib.mdDoc ''
description = ''
Permissions granted for the {option}`services.syncoid.user` user
for local source datasets. See
<https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html>
@ -147,7 +147,7 @@ in
type = types.listOf types.str;
default = [ "change-key" "compression" "create" "mount" "mountpoint" "receive" "rollback" ];
example = [ "create" "mount" "receive" "rollback" ];
description = lib.mdDoc ''
description = ''
Permissions granted for the {option}`services.syncoid.user` user
for local target datasets. See
<https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html>
@ -162,7 +162,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "--no-sync-snap" ];
description = lib.mdDoc ''
description = ''
Arguments to add to every syncoid command, unless disabled for that
command. See
<https://github.com/jimsalterjrs/sanoid/#syncoid-command-line-options>
@ -173,7 +173,7 @@ in
service = mkOption {
type = types.attrs;
default = { };
description = lib.mdDoc ''
description = ''
Systemd configuration common to all syncoid services.
'';
};
@ -184,7 +184,7 @@ in
source = mkOption {
type = types.str;
example = "pool/dataset";
description = lib.mdDoc ''
description = ''
Source ZFS dataset. Can be either local or remote. Defaults to
the attribute name.
'';
@ -193,18 +193,18 @@ in
target = mkOption {
type = types.str;
example = "user@server:pool/dataset";
description = lib.mdDoc ''
description = ''
Target ZFS dataset. Can be either local
(«pool/dataset») or remote
(«user@server:pool/dataset»).
'';
};
recursive = mkEnableOption (lib.mdDoc ''the transfer of child datasets'');
recursive = mkEnableOption ''the transfer of child datasets'';
sshKey = mkOption {
type = with types; nullOr (coercedTo path toString str);
description = lib.mdDoc ''
description = ''
SSH private key file to use to login to the remote system.
Defaults to {option}`services.syncoid.sshKey` option.
'';
@ -212,7 +212,7 @@ in
localSourceAllow = mkOption {
type = types.listOf types.str;
description = lib.mdDoc ''
description = ''
Permissions granted for the {option}`services.syncoid.user` user
for local source datasets. See
<https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html>
@ -223,7 +223,7 @@ in
localTargetAllow = mkOption {
type = types.listOf types.str;
description = lib.mdDoc ''
description = ''
Permissions granted for the {option}`services.syncoid.user` user
for local target datasets. See
<https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html>
@ -238,7 +238,7 @@ in
type = types.separatedString " ";
default = "";
example = "Lc e";
description = lib.mdDoc ''
description = ''
Advanced options to pass to zfs send. Options are specified
without their leading dashes and separated by spaces.
'';
@ -248,7 +248,7 @@ in
type = types.separatedString " ";
default = "";
example = "ux recordsize o compression=lz4";
description = lib.mdDoc ''
description = ''
Advanced options to pass to zfs recv. Options are specified
without their leading dashes and separated by spaces.
'';
@ -257,7 +257,7 @@ in
useCommonArgs = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to add the configured common arguments to this command.
'';
};
@ -265,7 +265,7 @@ in
service = mkOption {
type = types.attrs;
default = { };
description = lib.mdDoc ''
description = ''
Systemd configuration specific to this syncoid service.
'';
};
@ -274,7 +274,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "--sshport 2222" ];
description = lib.mdDoc "Extra syncoid arguments for this command.";
description = "Extra syncoid arguments for this command.";
};
};
config = {
@ -290,7 +290,7 @@ in
"pool/test".target = "root@target:pool/test";
}
'';
description = lib.mdDoc "Syncoid commands to run.";
description = "Syncoid commands to run.";
};
};