diff options
author | pennae <github@quasiparticle.net> | 2022-07-20 12:32:04 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-07-24 13:01:18 +0200 |
commit | 4f9183858429fba967a92519e6c63e3310a78ee5 (patch) | |
tree | 8460ae3056c9f5d7506ec10c9271e215628aa1c8 /nixos/modules | |
parent | 4ba72f8615691ba85266a9a961b93189549c02a1 (diff) | |
download | nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar.gz nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar.bz2 nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar.lz nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar.xz nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.tar.zst nixlib-4f9183858429fba967a92519e6c63e3310a78ee5.zip |
nixos/misc: invariant option docs MD conversions
Diffstat (limited to 'nixos/modules')
-rw-r--r-- | nixos/modules/misc/man-db.nix | 4 | ||||
-rw-r--r-- | nixos/modules/misc/mandoc.nix | 8 | ||||
-rw-r--r-- | nixos/modules/misc/version.nix | 16 |
3 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/misc/man-db.nix b/nixos/modules/misc/man-db.nix index 7aeb02d883ac..d267ad125646 100644 --- a/nixos/modules/misc/man-db.nix +++ b/nixos/modules/misc/man-db.nix @@ -36,8 +36,8 @@ in type = lib.types.package; default = pkgs.man-db; defaultText = lib.literalExpression "pkgs.man-db"; - description = '' - The <literal>man-db</literal> derivation to use. Useful to override + description = lib.mdDoc '' + The `man-db` derivation to use. Useful to override configuration options used for the package. ''; }; diff --git a/nixos/modules/misc/mandoc.nix b/nixos/modules/misc/mandoc.nix index 838f20876563..d67c42bff6a0 100644 --- a/nixos/modules/misc/mandoc.nix +++ b/nixos/modules/misc/mandoc.nix @@ -16,9 +16,9 @@ in { type = with lib.types; listOf str; default = [ "share/man" ]; example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]"; - description = '' + description = lib.mdDoc '' Change the manpath, i. e. the directories where - <citerefentry><refentrytitle>man</refentrytitle><manvolnum>1</manvolnum></citerefentry> + {manpage}`man(1)` looks for section-specific directories of man pages. You only need to change this setting if you want extra man pages (e. g. in non-english languages). All values must be strings that @@ -31,8 +31,8 @@ in { type = lib.types.package; default = pkgs.mandoc; defaultText = lib.literalExpression "pkgs.mandoc"; - description = '' - The <literal>mandoc</literal> derivation to use. Useful to override + description = lib.mdDoc '' + The `mandoc` derivation to use. Useful to override configuration options used for the package. ''; }; diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix index da458a574840..bdc3e5623be6 100644 --- a/nixos/modules/misc/version.nix +++ b/nixos/modules/misc/version.nix @@ -49,42 +49,42 @@ in nixos.version = mkOption { internal = true; type = types.str; - description = "The full NixOS version (e.g. <literal>16.03.1160.f2d4ee1</literal>)."; + description = lib.mdDoc "The full NixOS version (e.g. `16.03.1160.f2d4ee1`)."; }; nixos.release = mkOption { readOnly = true; type = types.str; default = trivial.release; - description = "The NixOS release (e.g. <literal>16.03</literal>)."; + description = lib.mdDoc "The NixOS release (e.g. `16.03`)."; }; nixos.versionSuffix = mkOption { internal = true; type = types.str; default = trivial.versionSuffix; - description = "The NixOS version suffix (e.g. <literal>1160.f2d4ee1</literal>)."; + description = lib.mdDoc "The NixOS version suffix (e.g. `1160.f2d4ee1`)."; }; nixos.revision = mkOption { internal = true; type = types.nullOr types.str; default = trivial.revisionWithDefault null; - description = "The Git revision from which this NixOS configuration was built."; + description = lib.mdDoc "The Git revision from which this NixOS configuration was built."; }; nixos.codeName = mkOption { readOnly = true; type = types.str; default = trivial.codeName; - description = "The NixOS release code name (e.g. <literal>Emu</literal>)."; + description = lib.mdDoc "The NixOS release code name (e.g. `Emu`)."; }; stateVersion = mkOption { type = types.str; default = cfg.release; defaultText = literalExpression "config.${opt.release}"; - description = '' + description = lib.mdDoc '' Every once in a while, a new NixOS release may change configuration defaults in a way incompatible with stateful data. For instance, if the default version of PostgreSQL @@ -108,13 +108,13 @@ in internal = true; type = types.str; default = "https://nixos.org/channels/nixos-unstable"; - description = "Default NixOS channel to which the root user is subscribed."; + description = lib.mdDoc "Default NixOS channel to which the root user is subscribed."; }; configurationRevision = mkOption { type = types.nullOr types.str; default = null; - description = "The Git revision of the top-level flake from which this configuration was built."; + description = lib.mdDoc "The Git revision of the top-level flake from which this configuration was built."; }; }; |