movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 21:50:33 +03:00
Code Activity

nixos/misc: invariant option docs MD conversions

Browse source
This commit is contained in:
pennae 2022-07-20 12:32:04 +02:00
parent 4ba72f8615
commit 4f91838584
3 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/misc/man-db.nix
View file

@ -36,8 +36,8 @@ in
type = lib.types.package; type = lib.types.package;
default = pkgs.man-db; default = pkgs.man-db;
defaultText = lib.literalExpression "pkgs.man-db"; defaultText = lib.literalExpression "pkgs.man-db";
description = '' description = lib.mdDoc ''
The <literal>man-db</literal> derivation to use. Useful to override The `man-db` derivation to use. Useful to override
configuration options used for the package. configuration options used for the package.
''; '';
}; };

8
nixos/modules/misc/mandoc.nix
View file

@ -16,9 +16,9 @@ in {
type = with lib.types; listOf str; type = with lib.types; listOf str;
default = [ "share/man" ]; default = [ "share/man" ];
example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]"; example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]";
description = '' description = lib.mdDoc ''
Change the manpath, i. e. the directories where 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. looks for section-specific directories of man pages.
You only need to change this setting if you want extra 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 (e. g. in non-english languages). All values must be strings that
@ -31,8 +31,8 @@ in {
type = lib.types.package; type = lib.types.package;
default = pkgs.mandoc; default = pkgs.mandoc;
defaultText = lib.literalExpression "pkgs.mandoc"; defaultText = lib.literalExpression "pkgs.mandoc";
description = '' description = lib.mdDoc ''
The <literal>mandoc</literal> derivation to use. Useful to override The `mandoc` derivation to use. Useful to override
configuration options used for the package. configuration options used for the package.
''; '';
}; };

16
nixos/modules/misc/version.nix
View file

@ -49,42 +49,42 @@ in
nixos.version = mkOption { nixos.version = mkOption {
internal = true; internal = true;
type = types.str; 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 { nixos.release = mkOption {
readOnly = true; readOnly = true;
type = types.str; type = types.str;
default = trivial.release; 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 { nixos.versionSuffix = mkOption {
internal = true; internal = true;
type = types.str; type = types.str;
default = trivial.versionSuffix; 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 { nixos.revision = mkOption {
internal = true; internal = true;
type = types.nullOr types.str; type = types.nullOr types.str;
default = trivial.revisionWithDefault null; 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 { nixos.codeName = mkOption {
readOnly = true; readOnly = true;
type = types.str; type = types.str;
default = trivial.codeName; 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 { stateVersion = mkOption {
type = types.str; type = types.str;
default = cfg.release; default = cfg.release;
defaultText = literalExpression "config.${opt.release}"; defaultText = literalExpression "config.${opt.release}";
description = '' description = lib.mdDoc ''
Every once in a while, a new NixOS release may change Every once in a while, a new NixOS release may change
configuration defaults in a way incompatible with stateful configuration defaults in a way incompatible with stateful
data. For instance, if the default version of PostgreSQL data. For instance, if the default version of PostgreSQL
@ -108,13 +108,13 @@ in
internal = true; internal = true;
type = types.str; type = types.str;
default = "https://nixos.org/channels/nixos-unstable"; 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 { configurationRevision = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; 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.";
}; };
}; };