Skip to content

Commit

Permalink
doc/fetchers: document downloadToTemp for fetchurl
Browse files Browse the repository at this point in the history
and postFetch
  • Loading branch information
teto committed Feb 14, 2024
1 parent 850b3bf commit d14a64a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/build-helpers/fetchers.chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ stdenv.mkDerivation {

The main difference between `fetchurl` and `fetchzip` is in how they store the contents. `fetchurl` will store the unaltered contents of the URL within the Nix store. `fetchzip` on the other hand, will decompress the archive for you, making files and directories directly accessible in the future. `fetchzip` can only be used with archives. Despite the name, `fetchzip` is not limited to .zip files and can also be used with any tarball.

- `downloadToTemp`: defaults to false. If true, saves the source under
`$TMPDIR/file`, to be used in conjunction with `postFetch`...
- `postFetch`: postprocess the downloaded archive

## `fetchpatch` {#fetchpatch}

`fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and performs normalization on them before computing the checksum. For example, it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time.
Expand Down

0 comments on commit d14a64a

Please sign in to comment.