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/misc/version.nix | |
parent | 4ba72f8615691ba85266a9a961b93189549c02a1 (diff) |
nixos/misc: invariant option docs MD conversions
Diffstat (limited to 'nixos/modules/misc/version.nix')
-rw-r--r-- | nixos/modules/misc/version.nix | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix index da458a5748401..bdc3e5623be68 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."; }; }; |