about summary refs log tree commit diff
path: root/nixpkgs
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2023-08-16 16:33:48 +0000
committerAlyssa Ross <hi@alyssa.is>2023-08-16 16:33:48 +0000
commit806587f64dae42a2921f66759cf71dbbbe8798c8 (patch)
treeca3bc5da651f51fa43d14901c767a1218e5761b1 /nixpkgs
parentdef59c21339a1a4c1995afbc3ab25a557cb8c141 (diff)
downloadnixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar.gz
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar.bz2
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar.lz
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar.xz
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.tar.zst
nixlib-806587f64dae42a2921f66759cf71dbbbe8798c8.zip
nixos: use mdDoc
Diffstat (limited to 'nixpkgs')
-rw-r--r--nixpkgs/nixos/modules/misc/documentation.nix5
-rw-r--r--nixpkgs/nixos/modules/services/hardware/evscript.nix8
-rw-r--r--nixpkgs/nixos/modules/services/mail/mailman.nix2
-rw-r--r--nixpkgs/nixos/modules/services/mail/public-inbox.nix4
-rw-r--r--nixpkgs/nixos/modules/services/web-servers/uwsgi.nix2
5 files changed, 10 insertions, 11 deletions
diff --git a/nixpkgs/nixos/modules/misc/documentation.nix b/nixpkgs/nixos/modules/misc/documentation.nix
index 0059ade84e7d..d9222fd0a622 100644
--- a/nixpkgs/nixos/modules/misc/documentation.nix
+++ b/nixpkgs/nixos/modules/misc/documentation.nix
@@ -193,9 +193,8 @@ in
       man.extraConfig = mkOption {
         type = types.lines;
         default = "";
-        description = ''
-          Lines to append to <citerefentry><refentrytitle>manpath</refentrytitle>
-          <manvolnum>5</manvolnum></citerefentry>.
+        description = mdDoc ''
+          Lines to append to {manpage}`manpath(5)`.
         '';
       };
 
diff --git a/nixpkgs/nixos/modules/services/hardware/evscript.nix b/nixpkgs/nixos/modules/services/hardware/evscript.nix
index 4736f088bfd8..6722887afb4f 100644
--- a/nixpkgs/nixos/modules/services/hardware/evscript.nix
+++ b/nixpkgs/nixos/modules/services/hardware/evscript.nix
@@ -7,23 +7,23 @@ in
 {
   options = with lib; {
     services.evscript = {
-      enable = mkEnableOption "the evscript service";
+      enable = mkEnableOption (mdDoc "the evscript service");
 
       package = mkOption {
-        description = "evscript package to use for the evscript service";
+        description = mdDoc "evscript package to use for the evscript service";
         type = types.package;
         default = pkgs.evscript;
         defaultText = literalExpression "pkgs.evscript";
       };
 
       devices = mkOption {
-        description = "evdev devices for evscript to listen to";
+        description = mdDoc "evdev devices for evscript to listen to";
         type = types.listOf types.path;
         example = [ "/dev/input/by-path/pci-0000:00:1d.0-usb-0:1.1:1.0-event-kbd" ];
       };
 
       script = mkOption {
-        description = "Dyon script for evscript service to run";
+        description = mdDoc "Dyon script for evscript service to run";
         type = types.path;
       };
     };
diff --git a/nixpkgs/nixos/modules/services/mail/mailman.nix b/nixpkgs/nixos/modules/services/mail/mailman.nix
index 3707738154e7..6cfa74de9b9f 100644
--- a/nixpkgs/nixos/modules/services/mail/mailman.nix
+++ b/nixpkgs/nixos/modules/services/mail/mailman.nix
@@ -294,7 +294,7 @@ in {
       extraConfig = mkOption {
         type = types.lines;
         default = "";
-        description = "Extra lines for the mailman configuration file";
+        description = lib.mdDoc "Extra lines for the mailman configuration file";
       };
 
     };
diff --git a/nixpkgs/nixos/modules/services/mail/public-inbox.nix b/nixpkgs/nixos/modules/services/mail/public-inbox.nix
index e8f943207b67..0464b7164149 100644
--- a/nixpkgs/nixos/modules/services/mail/public-inbox.nix
+++ b/nixpkgs/nixos/modules/services/mail/public-inbox.nix
@@ -191,7 +191,7 @@ in
           type = with types; listOf (enum [ "www" "manifest" ]);
           default = [];
           example = [ "www" "manifest" ];
-          description = "Listings to hide the inbox from";
+          description = lib.mdDoc "Listings to hide the inbox from";
         };
         options.newsgroup = mkOption {
           type = with types; nullOr str;
@@ -311,7 +311,7 @@ in
               type = with types; nullOr str;
               default = null;
               example = ''git clone <a href="https://example.com/">https://example.com/</a>'';
-              description = "HTML info about public-inbox's source code";
+              description = lib.mdDoc "HTML info about public-inbox's source code";
             };
             options.wwwlisting = mkOption {
               type = with types; enum [ "all" "404" "match=domain" ];
diff --git a/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix b/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix
index c076375ed857..6d3a18d71e91 100644
--- a/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix
+++ b/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix
@@ -188,7 +188,7 @@ in {
         type = types.listOf types.str;
         default = [];
         example = [ "--chmod-socket=664" ];
-        description = "Extra command line arguments for uwsgi.";
+        description = lib.mdDoc "Extra command line arguments for uwsgi.";
       };
     };
   };