about summary refs log tree commit diff
path: root/nixos/modules/misc
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/misc
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/misc')
-rw-r--r--nixos/modules/misc/assertions.nix4
-rw-r--r--nixos/modules/misc/crashdump.nix6
-rw-r--r--nixos/modules/misc/documentation/test.nix2
-rw-r--r--nixos/modules/misc/ids.nix4
-rw-r--r--nixos/modules/misc/label.nix4
-rw-r--r--nixos/modules/misc/lib.nix2
-rw-r--r--nixos/modules/misc/locate.nix18
-rw-r--r--nixos/modules/misc/man-db.nix8
-rw-r--r--nixos/modules/misc/meta.nix6
-rw-r--r--nixos/modules/misc/nixops-autoluks.nix2
-rw-r--r--nixos/modules/misc/nixpkgs-flake.nix6
-rw-r--r--nixos/modules/misc/nixpkgs.nix16
-rw-r--r--nixos/modules/misc/nixpkgs/read-only.nix10
-rw-r--r--nixos/modules/misc/passthru.nix2
-rw-r--r--nixos/modules/misc/version.nix24
-rw-r--r--nixos/modules/misc/wordlist.nix4
16 files changed, 59 insertions, 59 deletions
diff --git a/nixos/modules/misc/assertions.nix b/nixos/modules/misc/assertions.nix
index 364bb02be82de..550b3ac97f6a8 100644
--- a/nixos/modules/misc/assertions.nix
+++ b/nixos/modules/misc/assertions.nix
@@ -11,7 +11,7 @@ with lib;
       internal = true;
       default = [];
       example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
-      description = lib.mdDoc ''
+      description = ''
         This option allows modules to express conditions that must
         hold for the evaluation of the system configuration to
         succeed, along with associated error messages for the user.
@@ -23,7 +23,7 @@ with lib;
       default = [];
       type = types.listOf types.str;
       example = [ "The `foo' service is deprecated and will go away soon!" ];
-      description = lib.mdDoc ''
+      description = ''
         This option allows modules to show warnings to users during
         the evaluation of the system configuration.
       '';
diff --git a/nixos/modules/misc/crashdump.nix b/nixos/modules/misc/crashdump.nix
index 4ae18984ee5f5..b0f75d9caaa39 100644
--- a/nixos/modules/misc/crashdump.nix
+++ b/nixos/modules/misc/crashdump.nix
@@ -16,7 +16,7 @@ in
         enable = mkOption {
           type = types.bool;
           default = false;
-          description = lib.mdDoc ''
+          description = ''
             If enabled, NixOS will set up a kernel that will
             boot on crash, and leave the user in systemd rescue
             to be able to save the crashed kernel dump at
@@ -27,7 +27,7 @@ in
         reservedMemory = mkOption {
           default = "128M";
           type = types.str;
-          description = lib.mdDoc ''
+          description = ''
             The amount of memory reserved for the crashdump kernel.
             If you choose a too high value, dmesg will mention
             "crashkernel reservation failed".
@@ -36,7 +36,7 @@ in
         kernelParams = mkOption {
           type = types.listOf types.str;
           default = [ "1" "boot.shell_on_fail" ];
-          description = lib.mdDoc ''
+          description = ''
             Parameters that will be passed to the kernel kexec-ed on crash.
           '';
         };
diff --git a/nixos/modules/misc/documentation/test.nix b/nixos/modules/misc/documentation/test.nix
index dd1588abdb43a..1eaa63b1fb6ca 100644
--- a/nixos/modules/misc/documentation/test.nix
+++ b/nixos/modules/misc/documentation/test.nix
@@ -30,7 +30,7 @@ let
     specialArgs.someArg.myModule = { lib, ... }: {
       options.foobar = lib.mkOption {
         type = lib.types.str;
-        description = lib.mdDoc "The foobar option was added via specialArgs";
+        description = "The foobar option was added via specialArgs";
         default = "qux";
       };
     };
diff --git a/nixos/modules/misc/ids.nix b/nixos/modules/misc/ids.nix
index cfa98c838af52..f26917c0bad59 100644
--- a/nixos/modules/misc/ids.nix
+++ b/nixos/modules/misc/ids.nix
@@ -19,7 +19,7 @@ in
 
     ids.uids = lib.mkOption {
       internal = true;
-      description = lib.mdDoc ''
+      description = ''
         The user IDs used in NixOS.
       '';
       type = types.attrsOf types.int;
@@ -27,7 +27,7 @@ in
 
     ids.gids = lib.mkOption {
       internal = true;
-      description = lib.mdDoc ''
+      description = ''
         The group IDs used in NixOS.
       '';
       type = types.attrsOf types.int;
diff --git a/nixos/modules/misc/label.nix b/nixos/modules/misc/label.nix
index 44ee812249ce4..c7177f65a0fde 100644
--- a/nixos/modules/misc/label.nix
+++ b/nixos/modules/misc/label.nix
@@ -12,7 +12,7 @@ in
 
     nixos.label = mkOption {
       type = types.strMatching "[a-zA-Z0-9:_\\.-]*";
-      description = lib.mdDoc ''
+      description = ''
         NixOS version name to be used in the names of generated
         outputs and boot labels.
 
@@ -47,7 +47,7 @@ in
       type = types.listOf types.str;
       default = [];
       example = [ "with-xen" ];
-      description = lib.mdDoc ''
+      description = ''
         Strings to prefix to the default
         {option}`system.nixos.label`.
 
diff --git a/nixos/modules/misc/lib.nix b/nixos/modules/misc/lib.nix
index f97e9209e2f1e..121f396701eae 100644
--- a/nixos/modules/misc/lib.nix
+++ b/nixos/modules/misc/lib.nix
@@ -7,7 +7,7 @@
 
       type = lib.types.attrsOf lib.types.attrs;
 
-      description = lib.mdDoc ''
+      description = ''
         This option allows modules to define helper functions, constants, etc.
       '';
     };
diff --git a/nixos/modules/misc/locate.nix b/nixos/modules/misc/locate.nix
index 0dd4bf3f16f34..84c711c2b4efa 100644
--- a/nixos/modules/misc/locate.nix
+++ b/nixos/modules/misc/locate.nix
@@ -20,7 +20,7 @@ in
     enable = mkOption {
       type = bool;
       default = false;
-      description = lib.mdDoc ''
+      description = ''
         If enabled, NixOS will periodically update the database of
         files used by the {command}`locate` command.
       '';
@@ -34,7 +34,7 @@ in
       type = str;
       default = "02:15";
       example = "hourly";
-      description = lib.mdDoc ''
+      description = ''
         Update the locate database at this interval. Updates by
         default at 2:15 AM every day.
 
@@ -49,7 +49,7 @@ in
     extraFlags = mkOption {
       type = listOf str;
       default = [ ];
-      description = lib.mdDoc ''
+      description = ''
         Extra flags to pass to {command}`updatedb`.
       '';
     };
@@ -57,7 +57,7 @@ in
     output = mkOption {
       type = path;
       default = "/var/cache/locatedb";
-      description = lib.mdDoc ''
+      description = ''
         The database file to build.
       '';
     };
@@ -65,7 +65,7 @@ in
     localuser = mkOption {
       type = nullOr str;
       default = "nobody";
-      description = lib.mdDoc ''
+      description = ''
         The user to search non-network directories as, using
         {command}`su`.
       '';
@@ -153,7 +153,7 @@ in
         "vboxsf"
         "vperfctrfs"
       ];
-      description = lib.mdDoc ''
+      description = ''
         Which filesystem types to exclude from indexing
       '';
     };
@@ -170,7 +170,7 @@ in
         "/nix/store"
         "/nix/var/log/nix"
       ];
-      description = lib.mdDoc ''
+      description = ''
         Which paths to exclude from indexing
       '';
     };
@@ -182,7 +182,7 @@ in
         `[ ".bzr" ".cache" ".git" ".hg" ".svn" ]`, if
         supported by the locate implementation (i.e. mlocate or plocate).
       '';
-      description = lib.mdDoc ''
+      description = ''
         Directory components which should exclude paths containing them from indexing
       '';
     };
@@ -190,7 +190,7 @@ in
     pruneBindMounts = mkOption {
       type = bool;
       default = false;
-      description = lib.mdDoc ''
+      description = ''
         Whether not to index bind mounts
       '';
     };
diff --git a/nixos/modules/misc/man-db.nix b/nixos/modules/misc/man-db.nix
index 2b9805612186d..d557b5e20b0f2 100644
--- a/nixos/modules/misc/man-db.nix
+++ b/nixos/modules/misc/man-db.nix
@@ -7,7 +7,7 @@ in
 {
   options = {
     documentation.man.man-db = {
-      enable = lib.mkEnableOption (lib.mdDoc "man-db as the default man page viewer") // {
+      enable = lib.mkEnableOption "man-db as the default man page viewer" // {
         default = config.documentation.man.enable;
         defaultText = lib.literalExpression "config.documentation.man.enable";
         example = false;
@@ -17,7 +17,7 @@ in
         type = lib.types.listOf lib.types.package;
         default = [];
         internal = true;
-        description = lib.mdDoc ''
+        description = ''
           Packages to *not* include in the man-db.
           This can be useful to avoid unnecessary rebuilds due to packages that change frequently, like nixos-version.
         '';
@@ -34,7 +34,7 @@ in
           ignoreCollisions = true;
         };
         defaultText = lib.literalMD "all man pages in {option}`config.environment.systemPackages`";
-        description = lib.mdDoc ''
+        description = ''
           The manual pages to generate caches for if {option}`documentation.man.generateCaches`
           is enabled. Must be a path to a directory with man pages under
           `/share/man`; see the source for an example.
@@ -46,7 +46,7 @@ in
         type = lib.types.package;
         default = pkgs.man-db;
         defaultText = lib.literalExpression "pkgs.man-db";
-        description = lib.mdDoc ''
+        description = ''
           The `man-db` derivation to use. Useful to override
           configuration options used for the package.
         '';
diff --git a/nixos/modules/misc/meta.nix b/nixos/modules/misc/meta.nix
index 95f2765aff1eb..e5ab3a951537b 100644
--- a/nixos/modules/misc/meta.nix
+++ b/nixos/modules/misc/meta.nix
@@ -38,7 +38,7 @@ in
         internal = true;
         default = [];
         example = literalExpression ''[ lib.maintainers.all ]'';
-        description = lib.mdDoc ''
+        description = ''
           List of maintainers of each module.  This option should be defined at
           most once per module.
         '';
@@ -48,7 +48,7 @@ in
         type = docFile;
         internal = true;
         example = "./meta.chapter.md";
-        description = lib.mdDoc ''
+        description = ''
           Documentation prologue for the set of options of each module.  This
           option should be defined at most once per module.
         '';
@@ -60,7 +60,7 @@ in
         };
         internal = true;
         default = true;
-        description = lib.mdDoc ''
+        description = ''
           Whether to include this module in the split options doc build.
           Disable if the module references `config`, `pkgs` or other module
           arguments that cannot be evaluated as constants.
diff --git a/nixos/modules/misc/nixops-autoluks.nix b/nixos/modules/misc/nixops-autoluks.nix
index e6817633119d9..9b5a376027f52 100644
--- a/nixos/modules/misc/nixops-autoluks.nix
+++ b/nixos/modules/misc/nixops-autoluks.nix
@@ -5,7 +5,7 @@ let
 
   inherit (config.nixops) enableDeprecatedAutoLuks;
 in {
-  options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption (lib.mdDoc "the deprecated NixOps AutoLuks module");
+  options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption "the deprecated NixOps AutoLuks module";
 
   config = {
     assertions = [
diff --git a/nixos/modules/misc/nixpkgs-flake.nix b/nixos/modules/misc/nixpkgs-flake.nix
index 8bfe05ca19949..f58c3fbbe2e25 100644
--- a/nixos/modules/misc/nixpkgs-flake.nix
+++ b/nixos/modules/misc/nixpkgs-flake.nix
@@ -20,7 +20,7 @@ in
 
       example = ''builtins.fetchTarball { name = "source"; sha256 = "${lib.fakeHash}"; url = "https://github.com/nixos/nixpkgs/archive/somecommit.tar.gz"; }'';
 
-      description = mdDoc ''
+      description = ''
         The path to the nixpkgs sources used to build the system. This is automatically set up to be
         the store path of the nixpkgs flake used to build the system if using
         `nixpkgs.lib.nixosSystem`, and is otherwise null by default.
@@ -40,7 +40,7 @@ in
       default = cfg.source != null;
       defaultText = "config.nixpkgs.flake.source != null";
 
-      description = mdDoc ''
+      description = ''
         Whether to set {env}`NIX_PATH` to include `nixpkgs=flake:nixpkgs` such that `<nixpkgs>`
         lookups receive the version of nixpkgs that the system was built with, in concert with
         {option}`nixpkgs.flake.setFlakeRegistry`.
@@ -60,7 +60,7 @@ in
       default = cfg.source != null;
       defaultText = "config.nixpkgs.flake.source != null";
 
-      description = mdDoc ''
+      description = ''
         Whether to pin nixpkgs in the system-wide flake registry (`/etc/nix/registry.json`) to the
         store path of the sources of nixpkgs used to build the NixOS system.
 
diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix
index 10f800cd741a0..433bcd93213d9 100644
--- a/nixos/modules/misc/nixpkgs.nix
+++ b/nixos/modules/misc/nixpkgs.nix
@@ -112,7 +112,7 @@ in
       '';
       type = pkgsType;
       example = literalExpression "import <nixpkgs> {}";
-      description = lib.mdDoc ''
+      description = ''
         If set, the pkgs argument to all NixOS modules is the value of
         this option, extended with `nixpkgs.overlays`, if
         that is also set. Either `nixpkgs.crossSystem` or
@@ -152,7 +152,7 @@ in
           { allowBroken = true; allowUnfree = true; }
         '';
       type = configType;
-      description = lib.mdDoc ''
+      description = ''
         The configuration of the Nix Packages collection.  (For
         details, see the Nixpkgs documentation.)  It allows you to set
         package configuration options.
@@ -175,7 +175,7 @@ in
           ]
         '';
       type = types.listOf overlayType;
-      description = lib.mdDoc ''
+      description = ''
         List of overlays to apply to Nixpkgs.
         This option allows modifying the Nixpkgs package set accessed through the `pkgs` module argument.
 
@@ -193,7 +193,7 @@ in
       apply = lib.systems.elaborate;
       defaultText = literalExpression
         ''(import "''${nixos}/../lib").lib.systems.examples.aarch64-multiplatform'';
-      description = lib.mdDoc ''
+      description = ''
         Specifies the platform where the NixOS configuration will run.
 
         To cross-compile, set also `nixpkgs.buildPlatform`.
@@ -215,7 +215,7 @@ in
           else elaborated;
       defaultText = literalExpression
         ''config.nixpkgs.hostPlatform'';
-      description = lib.mdDoc ''
+      description = ''
         Specifies the platform on which NixOS should be built.
         By default, NixOS is built on the system where it runs, but you can
         change where it's built. Setting this option will cause NixOS to be
@@ -238,7 +238,7 @@ in
       apply = lib.systems.elaborate;
       defaultText = literalExpression
         ''(import "''${nixos}/../lib").lib.systems.examples.aarch64-multiplatform'';
-      description = lib.mdDoc ''
+      description = ''
         Systems with a recently generated `hardware-configuration.nix`
         do not need to specify this option, unless cross-compiling, in which case
         you should set *only* {option}`nixpkgs.buildPlatform`.
@@ -267,7 +267,7 @@ in
       type = types.nullOr types.attrs; # TODO utilize lib.systems.parsedPlatform
       default = null;
       example = { system = "aarch64-linux"; };
-      description = lib.mdDoc ''
+      description = ''
         Systems with a recently generated `hardware-configuration.nix`
         may instead specify *only* {option}`nixpkgs.buildPlatform`,
         or fall back to removing the {option}`nixpkgs.hostPlatform` line from the generated config.
@@ -306,7 +306,7 @@ in
       defaultText = lib.literalMD ''
         Traditionally `builtins.currentSystem`, but unset when invoking NixOS through `lib.nixosSystem`.
       '';
-      description = lib.mdDoc ''
+      description = ''
         This option does not need to be specified for NixOS configurations
         with a recently generated `hardware-configuration.nix`.
 
diff --git a/nixos/modules/misc/nixpkgs/read-only.nix b/nixos/modules/misc/nixpkgs/read-only.nix
index 2a783216a9d54..e3c4525e7db3c 100644
--- a/nixos/modules/misc/nixpkgs/read-only.nix
+++ b/nixos/modules/misc/nixpkgs/read-only.nix
@@ -24,33 +24,33 @@ in
     nixpkgs = {
       pkgs = mkOption {
         type = lib.types.pkgs;
-        description = lib.mdDoc ''The pkgs module argument.'';
+        description = ''The pkgs module argument.'';
       };
       config = mkOption {
         internal = true;
         type = types.unique { message = "nixpkgs.config is set to read-only"; } types.anything;
-        description = lib.mdDoc ''
+        description = ''
           The Nixpkgs `config` that `pkgs` was initialized with.
         '';
       };
       overlays = mkOption {
         internal = true;
         type = types.unique { message = "nixpkgs.overlays is set to read-only"; } types.anything;
-        description = lib.mdDoc ''
+        description = ''
           The Nixpkgs overlays that `pkgs` was initialized with.
         '';
       };
       hostPlatform = mkOption {
         internal = true;
         readOnly = true;
-        description = lib.mdDoc ''
+        description = ''
           The platform of the machine that is running the NixOS configuration.
         '';
       };
       buildPlatform = mkOption {
         internal = true;
         readOnly = true;
-        description = lib.mdDoc ''
+        description = ''
           The platform of the machine that built the NixOS configuration.
         '';
       };
diff --git a/nixos/modules/misc/passthru.nix b/nixos/modules/misc/passthru.nix
index beb9d78290377..4e99631fdd85c 100644
--- a/nixos/modules/misc/passthru.nix
+++ b/nixos/modules/misc/passthru.nix
@@ -7,7 +7,7 @@
   options = {
     passthru = lib.mkOption {
       visible = false;
-      description = lib.mdDoc ''
+      description = ''
         This attribute set will be exported as a system attribute.
         You can put whatever you want here.
       '';
diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix
index 79b95ac654d55..d582e0c162de3 100644
--- a/nixos/modules/misc/version.nix
+++ b/nixos/modules/misc/version.nix
@@ -65,55 +65,55 @@ in
       version = mkOption {
         internal = true;
         type = types.str;
-        description = lib.mdDoc "The full NixOS version (e.g. `16.03.1160.f2d4ee1`).";
+        description = "The full NixOS version (e.g. `16.03.1160.f2d4ee1`).";
       };
 
       release = mkOption {
         readOnly = true;
         type = types.str;
         default = trivial.release;
-        description = lib.mdDoc "The NixOS release (e.g. `16.03`).";
+        description = "The NixOS release (e.g. `16.03`).";
       };
 
       versionSuffix = mkOption {
         internal = true;
         type = types.str;
         default = trivial.versionSuffix;
-        description = lib.mdDoc "The NixOS version suffix (e.g. `1160.f2d4ee1`).";
+        description = "The NixOS version suffix (e.g. `1160.f2d4ee1`).";
       };
 
       revision = mkOption {
         internal = true;
         type = types.nullOr types.str;
         default = trivial.revisionWithDefault null;
-        description = lib.mdDoc "The Git revision from which this NixOS configuration was built.";
+        description = "The Git revision from which this NixOS configuration was built.";
       };
 
       codeName = mkOption {
         readOnly = true;
         type = types.str;
         default = trivial.codeName;
-        description = lib.mdDoc "The NixOS release code name (e.g. `Emu`).";
+        description = "The NixOS release code name (e.g. `Emu`).";
       };
 
       distroId = mkOption {
         internal = true;
         type = types.str;
         default = "nixos";
-        description = lib.mdDoc "The id of the operating system";
+        description = "The id of the operating system";
       };
 
       distroName = mkOption {
         internal = true;
         type = types.str;
         default = "NixOS";
-        description = lib.mdDoc "The name of the operating system";
+        description = "The name of the operating system";
       };
 
       variant_id = mkOption {
         type = types.nullOr (types.strMatching "^[a-z0-9._-]+$");
         default = null;
-        description = lib.mdDoc "A lower-case string identifying a specific variant or edition of the operating system";
+        description = "A lower-case string identifying a specific variant or edition of the operating system";
         example = "installer";
       };
     };
@@ -123,7 +123,7 @@ in
       id = lib.mkOption {
         type = types.nullOr (types.strMatching "^[a-z0-9._-]+$");
         default = null;
-        description = lib.mdDoc ''
+        description = ''
           Image identifier.
 
           This corresponds to the IMAGE_ID field in os-release. See the
@@ -137,7 +137,7 @@ in
       version = lib.mkOption {
         type = types.nullOr (types.strMatching "^[a-z0-9._-]+$");
         default = null;
-        description = lib.mdDoc ''
+        description = ''
           Image version.
 
           This corresponds to the IMAGE_VERSION field in os-release. See the
@@ -160,7 +160,7 @@ in
           v;
       default = cfg.release;
       defaultText = literalExpression "config.${opt.release}";
-      description = lib.mdDoc ''
+      description = ''
         This option defines the first version of NixOS you have installed on this particular machine,
         and is used to maintain compatibility with application data (e.g. databases) created on older NixOS versions.
 
@@ -193,7 +193,7 @@ in
     configurationRevision = mkOption {
       type = types.nullOr types.str;
       default = null;
-      description = lib.mdDoc "The Git revision of the top-level flake from which this configuration was built.";
+      description = "The Git revision of the top-level flake from which this configuration was built.";
     };
 
   };
diff --git a/nixos/modules/misc/wordlist.nix b/nixos/modules/misc/wordlist.nix
index f01fcb6f5a912..988b522d74314 100644
--- a/nixos/modules/misc/wordlist.nix
+++ b/nixos/modules/misc/wordlist.nix
@@ -8,7 +8,7 @@ in
 {
   options = {
     environment.wordlist = {
-      enable = mkEnableOption (lib.mdDoc "environment variables for lists of words");
+      enable = mkEnableOption "environment variables for lists of words";
 
       lists = mkOption {
         type = types.attrsOf (types.nonEmptyListOf types.path);
@@ -23,7 +23,7 @@ in
           }
         '';
 
-        description = lib.mdDoc ''
+        description = ''
           A set with the key names being the environment variable you'd like to
           set and the values being a list of paths to text documents containing
           lists of words. The various files will be merged, sorted, duplicates