doc: update fetchzip docs, add examples and follow conventions #302692
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
ofborg
bot
added
10.rebuild-darwin: 0
hsjobeki
reviewed
Apr 9, 2024
With updates in a doc team meeting with Valentin, Silvan and Johannes :)
infinisil
force-pushed
the
update-fetchzip
branch
from
a4c8ec9
to
e67c738
Compare
infinisil
approved these changes
Apr 11, 2024
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-04-11-documentation-team-meeting-notes-118/43203/1 |
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
This PR improves the documentation for
fetchzipby properly documenting all its attributes, how they differ fromfetchurl's, and shows examples of how to getfetchzipto do things that the previous documentation never mentioned.Since
fetchzipworks on top offetchurl, I decided to just refer the reader tofetchurlfor most of the inputs, rather than duplicating the information there.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.