mirrors/nixpkgs
1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-23 06:01:15 +00:00
Code Issues Wiki Activity
nixpkgs/nixos
History
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
..
doc nixos: doc: optionally include all modules in manual generation 2019-03-05 09:41:40 +00:00
lib nixos: doc: optionally include all modules in manual generation 2019-03-05 09:41:40 +00:00
maintainers Merge pull request #44573 from vincentbernat/feature/cloudstack 2019-02-24 08:28:42 -08:00
modules nixos: doc: optionally include all modules in manual generation 2019-03-05 09:41:40 +00:00
tests nixos/fish: generate autocompletions from man pages 2019-02-27 12:23:48 +01:00
COPYING
default.nix
README
release-combined.nix pantheon: init a 5.0 2019-01-24 20:54:14 +00:00
release-small.nix
release.nix nixos/sd-image-aarch64-new-kernel: Added to release 2018-12-26 11:03:32 +00:00

README 

*** NixOS ***

NixOS is a Linux distribution based on the purely functional package
management system Nix.  More information can be found at
http://nixos.org/nixos and in the manual in doc/manual.