3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/modules/misc
Arian van Putten 2e75a7b516 nixos: doc: optionally include all modules in manual generation
Before this change `man 5 configuration.nix` would only show options of modules in
the `baseModules` set, which consists only of the list of modules in
`nixos/modules/module-list.nix`

With this change applied and `documentation.nixos.includeAllModules` option enabled
all modules included in `configuration.nix` file will be used instead.

This makes configurations with custom modules self-documenting. It also means
that importing non-`baseModules` modules like `gce.nix` or `azure.nix`
will make their documentation available in `man 5 configuration.nix`.

`documentation.nixos.includeAllModules` is currently set to `false` by
default as enabling it usually uncovers bugs and prevents evaluation.
It should be set to `true` in a release or two.

This was originally implemented in #47177, edited for more configurability,
documented and rebased onto master by @oxij.
2019-03-05 09:41:40 +00:00
..
assertions.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
crashdump.nix nixos/crashdump: fix evaluation. (#30415) 2017-10-25 20:00:52 +00:00
documentation.nix nixos: doc: optionally include all modules in manual generation 2019-03-05 09:41:40 +00:00
extra-arguments.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
ids.nix Merge pull request #38033 from peterhoeg/f/slite 2019-02-23 15:10:06 -08:00
label.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
lib.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
locate.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
meta.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
nixpkgs.nix Revert "nixos/modules/misc/nixpkgs.nix: Use pure Nixpkgs function" 2019-01-15 13:11:09 +01:00
passthru.nix [bot] nixos/*: remove unused arguments in lambdas 2018-07-20 20:56:59 +00:00
version.nix nixos: version: cleanup a bit 2019-02-03 20:10:12 +00:00