nixpkgs/nixos/modules/misc/meta.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

89 lines
2.3 KiB
Nix
Raw Permalink Normal View History

{ lib, ... }:
let
2024-08-30 00:46:31 +02:00
maintainer = lib.mkOptionType {
name = "maintainer";
2024-08-30 00:46:31 +02:00
check = email: lib.elem email (lib.attrValues lib.maintainers);
merge =
loc: defs:
lib.listToAttrs (lib.singleton (lib.nameValuePair (lib.last defs).file (lib.last defs).value));
};
2024-08-30 00:46:31 +02:00
listOfMaintainers = lib.types.listOf maintainer // {
# Returns list of
# { "module-file" = [
# "maintainer1 <first@nixos.org>"
# "maintainer2 <second@nixos.org>" ];
# }
merge =
loc: defs:
2024-08-30 00:46:31 +02:00
lib.zipAttrs (
lib.flatten (
lib.imap1 (
n: def:
lib.imap1 (
m: def':
maintainer.merge (loc ++ [ "[${toString n}-${toString m}]" ]) [
{
inherit (def) file;
value = def';
}
]
) def.value
) defs
)
);
};
2024-08-30 00:46:31 +02:00
docFile = lib.types.path // {
# Returns tuples of
# { file = "module location"; value = <path/to/doc.xml>; }
merge = loc: defs: defs;
};
in
{
options = {
meta = {
2024-08-30 00:46:31 +02:00
maintainers = lib.mkOption {
type = listOfMaintainers;
internal = true;
default = [ ];
2024-08-30 00:46:31 +02:00
example = lib.literalExpression ''[ lib.maintainers.all ]'';
description = ''
2016-05-09 14:53:27 +09:00
List of maintainers of each module. This option should be defined at
most once per module.
'';
};
2024-08-30 00:46:31 +02:00
doc = lib.mkOption {
type = docFile;
internal = true;
example = "./meta.chapter.md";
description = ''
2021-02-21 06:50:05 +01:00
Documentation prologue for the set of options of each module. This
option should be defined at most once per module.
'';
};
2024-08-30 00:46:31 +02:00
buildDocsInSandbox = lib.mkOption {
type = lib.types.bool // {
merge = loc: defs: defs;
};
internal = true;
default = true;
description = ''
2021-02-21 06:50:05 +01:00
Whether to include this module in the split options doc build.
Disable if the module references `config`, `pkgs` or other module
2016-05-09 14:53:27 +09:00
arguments that cannot be evaluated as constants.
This option should be defined at most once per module.
'';
};
};
};
2024-08-30 00:46:31 +02:00
meta.maintainers = lib.singleton lib.maintainers.pierron;
}