about summary refs log tree commit diff
path: root/nixos/maintainers
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-28 21:18:44 +0200
committerpennae <github@quasiparticle.net>2022-08-31 16:32:53 +0200
commitef176dcf7e76c3639571d7c6051246c8fbadf12a (patch)
tree3bb88ef3515ace2ad477e245bf347213c6055464 /nixos/maintainers
parent5a643387ec1234c5f25357f2ff962a84895436f6 (diff)
downloadnixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.gz
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.bz2
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.lz
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.xz
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.zst
nixlib-ef176dcf7e76c3639571d7c6051246c8fbadf12a.zip
nixos/*: automatically convert option descriptions
conversions were done using https://github.com/pennae/nix-doc-munge
using (probably) rev f34e145 running

    nix-doc-munge nixos/**/*.nix
    nix-doc-munge --import nixos/**/*.nix

the tool ensures that only changes that could affect the generated
manual *but don't* are committed, other changes require manual review
and are discarded.
Diffstat (limited to 'nixos/maintainers')
-rw-r--r--nixos/maintainers/scripts/openstack/openstack-image-zfs.nix6
1 files changed, 3 insertions, 3 deletions
diff --git a/nixos/maintainers/scripts/openstack/openstack-image-zfs.nix b/nixos/maintainers/scripts/openstack/openstack-image-zfs.nix
index d62a560642d0..f73e251d3046 100644
--- a/nixos/maintainers/scripts/openstack/openstack-image-zfs.nix
+++ b/nixos/maintainers/scripts/openstack/openstack-image-zfs.nix
@@ -16,20 +16,20 @@ in
   options.openstackImage = {
     name = mkOption {
       type = types.str;
-      description = "The name of the generated derivation";
+      description = lib.mdDoc "The name of the generated derivation";
       default = "nixos-openstack-image-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
     };
 
     sizeMB = mkOption {
       type = types.int;
       default = 8192;
-      description = "The size in MB of the image";
+      description = lib.mdDoc "The size in MB of the image";
     };
 
     format = mkOption {
       type = types.enum [ "raw" "qcow2" ];
       default = "qcow2";
-      description = "The image format to output";
+      description = lib.mdDoc "The image format to output";
     };
   };