From 7e7d68a250f75678451cd44f8c3d585bf750461e Mon Sep 17 00:00:00 2001 From: pennae Date: Sun, 14 Aug 2022 09:03:30 +0200 Subject: nixos/*: mark pre-existing markdown descriptions as mdDoc --- nixos/modules/services/misc/gitea.nix | 2 +- nixos/modules/services/misc/klipper.nix | 2 +- nixos/modules/services/misc/nix-daemon.nix | 2 +- nixos/modules/services/misc/rmfakecloud.nix | 2 +- nixos/modules/services/misc/zoneminder.nix | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'nixos/modules/services/misc') diff --git a/nixos/modules/services/misc/gitea.nix b/nixos/modules/services/misc/gitea.nix index 048ff32116544..5bcc0fbc7e19c 100644 --- a/nixos/modules/services/misc/gitea.nix +++ b/nixos/modules/services/misc/gitea.nix @@ -183,7 +183,7 @@ in file = mkOption { type = types.nullOr types.str; default = null; - description = "Filename to be used for the dump. If `null` a default name is choosen by gitea."; + description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea."; example = "gitea-dump"; }; }; diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index 34e9acc71929f..0dadc0c747051 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -82,7 +82,7 @@ in ''; configFile = mkOption { type = path; - description = "Path to firmware config which is generated using `klipper-genconf`"; + description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`"; }; }; }); diff --git a/nixos/modules/services/misc/nix-daemon.nix b/nixos/modules/services/misc/nix-daemon.nix index a218b0048977a..4022c7ebbc2f4 100644 --- a/nixos/modules/services/misc/nix-daemon.nix +++ b/nixos/modules/services/misc/nix-daemon.nix @@ -264,7 +264,7 @@ in type = types.nullOr types.str; default = null; example = "/root/.ssh/id_buildhost_builduser"; - description = '' + description = lib.mdDoc '' The path to the SSH private key with which to authenticate on the build machine. The private key must not have a passphrase. If null, the building user (root on NixOS machines) must have an diff --git a/nixos/modules/services/misc/rmfakecloud.nix b/nixos/modules/services/misc/rmfakecloud.nix index 2feb663f7cb69..c1b5291ce2007 100644 --- a/nixos/modules/services/misc/rmfakecloud.nix +++ b/nixos/modules/services/misc/rmfakecloud.nix @@ -50,7 +50,7 @@ in { type = with types; attrsOf str; default = { }; example = { DATADIR = "/custom/path/for/rmfakecloud/data"; }; - description = '' + description = lib.mdDoc '' Extra settings in the form of a set of key-value pairs. For tokens and secrets, use `environmentFile` instead. diff --git a/nixos/modules/services/misc/zoneminder.nix b/nixos/modules/services/misc/zoneminder.nix index ef3f6c1a0fd95..fa0e06a014807 100644 --- a/nixos/modules/services/misc/zoneminder.nix +++ b/nixos/modules/services/misc/zoneminder.nix @@ -80,7 +80,7 @@ in { webserver = mkOption { type = types.enum [ "nginx" "none" ]; default = "nginx"; - description = '' + description = lib.mdDoc '' The webserver to configure for the PHP frontend. Set it to `none` if you want to configure it yourself. PRs are welcome -- cgit 1.4.1