Nixpkgs manual: expand documentation for overlays #28082
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
joachifm
reviewed
Aug 11, 2017
|
|
||
| <para>The set of overlays is looked for in the following places. The | ||
| first one present is considered, and all the rest are ignored: | ||
| <para>The list of overlays is determined as follows: |
There was a problem hiding this comment.
Maybe I missed it, but seems like the new version does not mention that only the first match is used (or is that not actually the case?)
There was a problem hiding this comment.
I worded the list items using "otherwise" to indicate that each one only applies if the conditions from the previous ones didn't hold, but perhaps it's not clear?
8 tasks
nbp
approved these changes
Aug 13, 2017
doc/overlays.xml
Outdated
| <filename>default.nix</filename>, or a symlink to one of those. The expressions should follow | ||
| the syntax described in <xref linkend="sec-overlays-layout"/>.</para> | ||
| <para>For the second and third options overlays can be provided as files, | ||
| directories containing a <filename>default.nix</filename>, or symlinks to one of those.</para> |
There was a problem hiding this comment.
nit: For the second and third options*,* overlays are registered in the given directory as files, directories containing …
8 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
This expands the documentation on overlays on a few points which confused me when I was trying to use them:
nixpkgs.overlays.<nixpkgs-overlays>.packageOverrides.I wasn't sure whether it was right to discuss NixOS issues in the Nixkpgs manual, but it seems to be done in other places, so I left it in. Ideally, it would be nice to be able to link from the NixOS manual to the Nixpkgs manual, but I'm not sure if this is possible?
Things done
Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers.
(nix.useSandbox on NixOS,
or option
build-use-sandboxinnix.confon non-NixOS)
nix-shell -p nox --run "nox-review wip"./result/bin/)