public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/modules: Expose the internal module in the top-level documentation

This commit is contained in:
Silvan Mosberger 2020-09-02 18:01:10 +02:00
parent 1e6a84b7af
commit 3759a77fcd
No known key found for this signature in database
GPG Key ID: E8F1E9EAD284E17D
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/modules.nix
View File

@ -77,10 +77,15 @@ rec {
# attribute. These options are fragile, as they are used by the # attribute. These options are fragile, as they are used by the
# module system to change the interpretation of modules. # module system to change the interpretation of modules.
internalModule = rec { internalModule = rec {
_file = ./modules.nix; # FIXME: Using ./modules.nix directly breaks the doc for some reason
_file = "lib/modules.nix";
key = _file; key = _file;
# These options are set to be internal only for prefix != [], aka it's
# a submodule evaluation. This way their docs are displayed only once
# as a top-level NixOS option, but will be hidden for all submodules,
# even though they are available there too
options = { options = {
_module.args = mkOption { _module.args = mkOption {
# Because things like `mkIf` are entirely useless for # Because things like `mkIf` are entirely useless for
@ -90,13 +95,13 @@ rec {
# a `_module.args.pkgs = import (fetchTarball { ... }) {}` won't # a `_module.args.pkgs = import (fetchTarball { ... }) {}` won't
# start a download when `pkgs` wasn't evaluated. # start a download when `pkgs` wasn't evaluated.
type = types.lazyAttrsOf types.unspecified; type = types.lazyAttrsOf types.unspecified;
internal = true; internal = prefix != [];
description = "Arguments passed to each module."; description = "Arguments passed to each module.";
}; };
_module.check = mkOption { _module.check = mkOption {
type = types.bool; type = types.bool;
internal = true; internal = prefix != [];
default = check; default = check;
description = "Whether to check whether all option definitions have matching declarations."; description = "Whether to check whether all option definitions have matching declarations.";
}; };
@ -104,7 +109,7 @@ rec {
_module.freeformType = mkOption { _module.freeformType = mkOption {
# Disallow merging for now, but could be implemented nicely with a `types.optionType` # Disallow merging for now, but could be implemented nicely with a `types.optionType`
type = types.nullOr (types.uniq types.attrs); type = types.nullOr (types.uniq types.attrs);
internal = true; internal = prefix != [];
default = null; default = null;
description = '' description = ''
If set, merge all definitions that don't have an associated option If set, merge all definitions that don't have an associated option
@ -141,7 +146,7 @@ rec {
} }
''; '';
default = {}; default = {};
internal = true; internal = prefix != [];
type = types.attrsOf (types.submodule { type = types.attrsOf (types.submodule {
# TODO: Rename to assertion? Or allow also setting assertion? # TODO: Rename to assertion? Or allow also setting assertion?
options.enable = mkOption { options.enable = mkOption {

2
lib/tests/misc.nix
View File

@ -655,7 +655,7 @@ runTests {
modules = [ module ]; modules = [ module ];
}).options; }).options;
locs = filter (o: ! o.internal) (optionAttrSetToDocList options); locs = filter (o: ! o.internal) (optionAttrSetToDocList (removeAttrs options [ "_module" ]));
in map (o: o.loc) locs; in map (o: o.loc) locs;
expected = [ [ "foo" ] [ "foo" "<name>" "bar" ] [ "foo" "bar" ] ]; expected = [ [ "foo" ] [ "foo" "<name>" "bar" ] [ "foo" "bar" ] ];
}; };