3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/lib
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
..
test-driver Revert "Add ssh backdoor to VM tests infrastructure." 2019-01-19 13:24:39 -05:00
testing
build-vms.nix
eval-config.nix nixos: doc: optionally include all modules in manual generation 2019-03-05 09:41:40 +00:00
from-env.nix
make-channel.nix
make-disk-image.nix Add options to build disk image function (#50239) 2019-01-24 01:47:55 +02:00
make-ext4-fs.nix lib/make-ext4-fs: more efficient store maker 2018-12-24 23:21:15 +03:00
make-iso9660-image.nix
make-iso9660-image.sh
make-squashfs.nix kernel config: add support for CONFIG_SQUASHFS_ZSTD (#52967) 2019-01-17 15:24:44 +02:00
make-system-tarball.nix
make-system-tarball.sh
qemu-flags.nix
testing.nix nixos/lib/testing.nix: config defaults to {} 2019-02-06 20:04:24 -05:00
utils.nix fix infinite recursion caused by the unnecessary inspection of options + fix is parent of mount point check (#51541) 2018-12-24 14:05:55 +01:00