trivial-builders: Deduplicate docs#294944
Merged
infinisil merged 1 commit intoNixOS:masterfrom Mar 12, 2024
Merged
Conversation
I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation.
github-actions
bot
added
the
8.has: documentation
13 tasks
ofborg
bot
added
10.rebuild-darwin: 0
Comment on lines
+626
to
628
| # Docs in doc/build-helpers/trivial-build-helpers.chapter.md | ||
| # See https://nixos.org/manual/nixpkgs/unstable/#trivial-builder-writeReferencesToFile | ||
| writeReferencesToFile = path: runCommand "runtime-deps" |
Contributor
There was a problem hiding this comment.
How is this going to reflect on NixOS/nix#9054?
Member
Author
There was a problem hiding this comment.
They can be moved back, and something like nixdoc can be added.
For now what matters is that there's no more duplication and contributors know where to add their docs when they change/add things.
infinisil
approved these changes
Mar 12, 2024
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-03-21-documentation-team-meeting-notes-114/41957/1 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Clean up duplicated docs and stop any confusion around where to write them.
I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation.
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.