about summary refs log tree commit diff
path: root/nixos/modules/image
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/image
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/image')
-rw-r--r--nixos/modules/image/repart.nix36
1 files changed, 18 insertions, 18 deletions
diff --git a/nixos/modules/image/repart.nix b/nixos/modules/image/repart.nix
index 569d4a4b00215..e471f9485cd03 100644
--- a/nixos/modules/image/repart.nix
+++ b/nixos/modules/image/repart.nix
@@ -13,13 +13,13 @@ let
       storePaths = lib.mkOption {
         type = with lib.types; listOf path;
         default = [ ];
-        description = lib.mdDoc "The store paths to include in the partition.";
+        description = "The store paths to include in the partition.";
       };
 
       stripNixStorePrefix = lib.mkOption {
         type = lib.types.bool;
         default = false;
-        description = lib.mdDoc ''
+        description = ''
           Whether to strip `/nix/store/` from the store paths. This is useful
           when you want to build a partition that only contains store paths and
           is mounted under `/nix/store`.
@@ -31,7 +31,7 @@ let
           options = {
             source = lib.mkOption {
               type = types.path;
-              description = lib.mdDoc "Path of the source file.";
+              description = "Path of the source file.";
             };
           };
         });
@@ -44,7 +44,7 @@ let
             "/loader/entries/nixos.conf".source = systemdBootEntry;
           }
         '';
-        description = lib.mdDoc "The contents to end up in the filesystem image.";
+        description = "The contents to end up in the filesystem image.";
       };
 
       repartConfig = lib.mkOption {
@@ -54,7 +54,7 @@ let
           SizeMinBytes = "512M";
           SizeMaxBytes = "2G";
         };
-        description = lib.mdDoc ''
+        description = ''
           Specify the repart options for a partiton as a structural setting.
           See <https://www.freedesktop.org/software/systemd/man/repart.d.html>
           for all available options.
@@ -73,7 +73,7 @@ in
 
     name = lib.mkOption {
       type = lib.types.str;
-      description = lib.mdDoc ''
+      description = ''
         Name of the image.
 
         If this option is unset but config.system.image.id is set,
@@ -85,13 +85,13 @@ in
       type = lib.types.nullOr lib.types.str;
       default = config.system.image.version;
       defaultText = lib.literalExpression "config.system.image.version";
-      description = lib.mdDoc "Version of the image";
+      description = "Version of the image";
     };
 
     imageFileBasename = lib.mkOption {
       type = lib.types.str;
       readOnly = true;
-      description = lib.mdDoc ''
+      description = ''
         Basename of the image filename without any extension (e.g. `image_1`).
       '';
     };
@@ -99,24 +99,24 @@ in
     imageFile = lib.mkOption {
       type = lib.types.str;
       readOnly = true;
-      description = lib.mdDoc ''
+      description = ''
         Filename of the image including all extensions (e.g `image_1.raw` or
         `image_1.raw.zst`).
       '';
     };
 
     compression = {
-      enable = lib.mkEnableOption (lib.mdDoc "Image compression");
+      enable = lib.mkEnableOption "Image compression";
 
       algorithm = lib.mkOption {
         type = lib.types.enum [ "zstd" "xz" ];
         default = "zstd";
-        description = lib.mdDoc "Compression algorithm";
+        description = "Compression algorithm";
       };
 
       level = lib.mkOption {
         type = lib.types.int;
-        description = lib.mdDoc ''
+        description = ''
           Compression level. The available range depends on the used algorithm.
         '';
       };
@@ -126,7 +126,7 @@ in
       type = with lib.types; nullOr str;
       # Generated with `uuidgen`. Random but fixed to improve reproducibility.
       default = "0867da16-f251-457d-a9e8-c31f9a3c220b";
-      description = lib.mdDoc ''
+      description = ''
         A UUID to use as a seed. You can set this to `null` to explicitly
         randomize the partition UUIDs.
       '';
@@ -135,7 +135,7 @@ in
     split = lib.mkOption {
       type = lib.types.bool;
       default = false;
-      description = lib.mdDoc ''
+      description = ''
         Enables generation of split artifacts from partitions. If enabled, for
         each partition with SplitName= set, a separate output file containing
         just the contents of that partition is generated.
@@ -146,7 +146,7 @@ in
       type = with lib.types; nullOr int;
       default = 512;
       example = lib.literalExpression "4096";
-      description = lib.mdDoc ''
+      description = ''
         The sector size of the disk image produced by systemd-repart. This
         value must be a power of 2 between 512 and 4096.
       '';
@@ -184,7 +184,7 @@ in
           };
         };
       '';
-      description = lib.mdDoc ''
+      description = ''
         Specify partitions as a set of the names of the partitions with their
         configuration as the key.
       '';
@@ -198,7 +198,7 @@ in
           vfat = [ "-S 512" "-c" ];
         }
       '';
-      description = lib.mdDoc ''
+      description = ''
         Specify extra options for created file systems. The specified options
         are converted to individual environment variables of the format
         `SYSTEMD_REPART_MKFS_OPTIONS_<FSTYPE>`.
@@ -217,7 +217,7 @@ in
       type = lib.types.attrs;
       internal = true;
       readOnly = true;
-      description = lib.mdDoc ''
+      description = ''
         Convenience option to access partitions with added closures.
       '';
     };