nixos: doc: implement related packages in the manual #32424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…f their option group Why? Because this way configuration.nix(5) can be read linearly. Before: > virtualisation.xen.bootParams > ... > virtualisation.xen.enable > ... > virtualisation.xen.package > ... After: > virtualisation.xen.enable > virtualisation.xen.package > virtualisation.xen.bootParams > ...
This allows one to specify "related packages" in NixOS that get rendered into the configuration.nix(5) man page. The interface philosophy is pretty much stolen from TeX bibliography.
7 tasks
oxij
changed the title
oxij
changed the title
|
Awesome PR! |
|
A single comment to what was a long heated discussion a number of times
before seems kinda strange.
Are there any objections to this? Isn't this a dream come true?
|
This was referenced Dec 23, 2017
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
A rebase and a partial rewrite of #14860 which I can't reopen for some reason that implements #9306 (finally!).
This version doesn't define any new types or
mkOptions. It's super-uber-simple.It does this
(that's an old screenshot from #14860, this version looks a tiny bit different, but I'm too lazy to make a new one, its close enough)
when you write f56b582.
Adding
relatedPackagesto options puts a pressure on package maintainers to maintain good package descriptions or else the manual would look very ugly. Its a good thing.Things done
configure.nixbuilds.