Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: NixOS/nixpkgs
base: 456f09d76fca
Choose a base ref
...
head repository: NixOS/nixpkgs
compare: 1f409d0879e4
Choose a head ref
  • 4 commits
  • 5 files changed
  • 3 contributors

Commits on Mar 5, 2019

  1. 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.
    @arianvp @oxij
    arianvp authored and oxij committed Mar 5, 2019
    Copy the full SHA
    2e75a7b View commit details
    Browse the repository at this point in the history

  2. nixos: doc: increase maxdepth for xsltproc 

    See #37903 (comment)
for details. With the previous patch and some custom modules included in
`configuration.nix` the above bug is very easy to trigger.

This is a simplest workaround I have. A proper solution would look like
#37903 (comment).
    @oxij
    oxij committed Mar 5, 2019
    Copy the full SHA
    ca496b1 View commit details
    Browse the repository at this point in the history

  3. lib: optionAttrSetToDocList: warn instead of throwing on options with… 

    …out descriptions

For convenience, it's not like not having a description is deadly or something.
    @oxij
    oxij committed Mar 5, 2019
    Copy the full SHA
    a53b3ba View commit details
    Browse the repository at this point in the history

  4. Merge pull request #56020 from oxij/pull/47177-nixos-doc-include-all-… 

    …modules-edited

nixos: doc: include all modules in manual generation
    @danbst
    danbst committed Mar 5, 2019
    Copy the full SHA
    1f409d0 View commit details
    Browse the repository at this point in the history