doc/fetchers: document downloadToTemp for fetchurl #288762
Conversation
| - `downloadToTemp`: defaults to false. If true, saves the source under | ||
| `$TMPDIR/file`, to be used in conjunction with `postFetch`... | ||
| - `postFetch`: postprocess the downloaded archive |
There was a problem hiding this comment.
Can you add some more text explaining that these are only applicable to fetchurl, and not fetchzip? The section this text is in talks about both, and the paragraph just before this ends talking about fetchzip, so this new text is definitely confusing as-is.
Regarding the documentation for downloadToTemp, I think documenting that it saves to $TMPDIR/file might not be a good idea to avoid people directly using that value in their code. It might be best to document that the temporary file path will be at $downloadedFile.
Also, can you add more text explaining postFetch? What type is it? How do you use it? The documentation in the code for postFetch is more descriptive, you can use it as a starting point.
and postFetch
|
@DanielSidhion I would rather not selfmerge this since it's your area of expertise. I did the change because I was looking into how to use downloadToTemp for another PR. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-02-22-documentation-team-meeting-notes-110/40145/1 |
* doc/fetchers: document downloadToTemp for fetchurl Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
and postFetch
Description of changes
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.