nixpkgs/nixos/modules/misc/meta.nix

62 lines
1.5 KiB
Nix
Raw Normal View History

{ lib, ... }:
with lib;
let
maintainer = mkOptionType {
name = "maintainer";
check = email: elem email (attrValues lib.maintainers);
merge = loc: defs: listToAttrs (singleton (nameValuePair (last defs).file (last defs).value));
};
listOfMaintainers = types.listOf maintainer // {
# Returns list of
# { "module-file" = [
# "maintainer1 <first@nixos.org>"
# "maintainer2 <second@nixos.org>" ];
# }
merge = loc: defs:
zipAttrs
(flatten (imap1 (n: def: imap1 (m: def':
maintainer.merge (loc ++ ["[${toString n}-${toString m}]"])
[{ inherit (def) file; value = def'; }]) def.value) defs));
};
docFile = types.path // {
# Returns tuples of
# { file = "module location"; value = <path/to/doc.xml>; }
merge = loc: defs: defs;
};
in
{
options = {
meta = {
maintainers = mkOption {
type = listOfMaintainers;
internal = true;
default = [];
example = [ lib.maintainers.all ];
description = ''
2016-05-09 05:53:27 +00:00
List of maintainers of each module. This option should be defined at
most once per module.
'';
};
doc = mkOption {
type = docFile;
internal = true;
2021-02-21 05:50:05 +00:00
example = "./meta.chapter.xml";
description = ''
2021-02-21 05:50:05 +00:00
Documentation prologue for the set of options of each module. This
option should be defined at most once per module.
'';
};
};
};
2016-05-09 05:53:27 +00:00
meta.maintainers = singleton lib.maintainers.pierron;
}