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.
This commit is contained in:
pennae
2022-08-28 21:18:44 +02:00
parent 5a643387ec
commit ef176dcf7e
808 changed files with 1523 additions and 1523 deletions

View File

@@ -231,10 +231,10 @@ in
type = types.nullOr types.str;
default = null;
example = "x86_64-linux";
description = ''
description = lib.mdDoc ''
The system type the build machine can execute derivations on.
Either this attribute or <varname>systems</varname> must be
present, where <varname>system</varname> takes precedence if
Either this attribute or {var}`systems` must be
present, where {var}`system` takes precedence if
both are set.
'';
};
@@ -242,10 +242,10 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "x86_64-linux" "aarch64-linux" ];
description = ''
description = lib.mdDoc ''
The system types the build machine can execute derivations on.
Either this attribute or <varname>system</varname> must be
present, where <varname>system</varname> takes precedence if
Either this attribute or {var}`system` must be
present, where {var}`system` takes precedence if
both are set.
'';
};
@@ -297,11 +297,11 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "big-parallel" ];
description = ''
description = lib.mdDoc ''
A list of features mandatory for this builder. The builder will
be ignored for derivations that don't require all features in
this list. All mandatory features are automatically included in
<varname>supportedFeatures</varname>.
{var}`supportedFeatures`.
'';
};
supportedFeatures = mkOption {