doc: Prevent evaluation warnings #328269
Merged
doc: Prevent evaluation warnings #328269
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
Problem: `nix-build doc` gives a bunch of warnings because it inspects `lib` to figure out where all the symbols are. Solution: Move the step of figuring out where the symbols are to a Nix evaluation inside a derivation instead.
github-actions
bot
added
the
8.has: documentation
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/suppress-warnings-for-a-derivation/49271/4 |
ofborg
bot
added
10.rebuild-darwin: 0
hsjobeki
approved these changes
Jul 19, 2024
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.
Description of changes
Building the manual using
nix-build docpreviously gave a bunch of warnings because it inspectslibto figure out where all the symbols are. This relates to nix-community/nixdoc#128.This is not great, because these warnings are not something that can be fixed by the caller, so anybody that depends on the manual build will see them for every evaluation (e.g. as reported here).
This PR solves this by moving the step of figuring out where the symbols are to a Nix evaluation inside a derivation instead, such that the warnings only trigger during build time, and the result of it can be cached too.
Things done
nix-build doconx86_64-linuxThis work is sponsored by Antithesis ✨
Add a 👍 reaction to pull requests you find important.