summaryrefslogtreecommitdiff
path: root/doc/build-helpers/fetchers.chapter.md (follow)
Commit message (Expand)AuthorAgeFilesLines
* fetchgit: Add rootDir argument (#427165)Philip Taron2025-08-101-0/+4
|\
| * fetchgit: Add rootDir argument•••With this argument fetchgit will make a subdirectory of the Git repository a root of the resulting store path. This is helpful for dealing with monorepos where many projects are in separate directories and don't need a new source hash every time the monorepo is updated. Commit hash is removed from the name of the derivation to prevent it from changing the store path when nothing in the subdirectory changes. Yuriy Taraday2025-08-081-0/+4
* | tor: add tor.proxyHook•••tor.proxyHook is a setup hook intended for use with HTTP-based fetchers, enabling them to download from .onion addresses using Tor as a proxy. Ryan Hendrickson2025-07-241-0/+2
|/
* fetchhg: make argument hash overridableYueh-Shun Li2025-07-091-1/+1
* pkgs/build-support/fetchgit: add fetchTags parameter•••Added fetchTags feature to fetchgit, explicit and clear support for fetching all tags after the source tree fetch completes. Doing this at build-time in the fetcher is required for packages that invoke commands like 'git describe' which require tags, and since the nix store is read-only by design, it is not possible to git fetch --tags at activation- or run-time. This feature may have been possible by specifying a postFetch option including calling git fetch --tags, however doing so obfuscates the solution to this very real problem. Explicit support for fetching tags should be a first class citizen just like fetching other refs. Tim Black2025-05-281-0/+4
* fetchgit: add preFetch hook•••This allows running code to change the environment before the nix-prefetch-git script is run. In particular, it allows setting things like NIX_PREFETCH_GIT_CHECKOUT_HOOK, which allows additional code to be run before deleting the .git directory. This also means there's potentially value in performing a deep clone then removing the .git directory, so remove the assertion that prevents doing so. Adam Dinwoodie2025-05-061-1/+6
* doc: update Nix code snippets format•••Command: `mdcr --config doc/tests/mdcr-config.toml doc/` Pol Dellaiera2025-04-171-5/+12
* doc: fix fetchDebianPatch examplePatrick2024-12-301-1/+1
* fetchgit{,hub}: add tag argument•••It's become a common pattern to use `rev = "refs/tags/${version}"` rather than just `rev = version` to ensure that the tag gets fetched rather than a branch that has the same name. This has so far been done using boilerplate though, so let's add a simple abstraction to fetch a tag instead. Atemu2024-11-181-1/+4
* doc: document commonly used fetchgit flags•••Some important ones like fetchLFS were missing. See https://discourse.nixos.org/t/how-to-use-git-lfs-with-fetchgit/55975 for a documented instance where this confused a user. This still isn't complete but the remaining ones I felt were rather niche and I am not familiar enough with them to sufficiently document their purpose or usage. Atemu2024-11-141-16/+54
* doc: add proxy usage to fetchers chapterTim Cuthbertson2024-08-231-0/+6
* doc/fetchers: correct fetchtorrent sha256 attribute to hash•••This seems incorrect because sha256 is not an acceptable attribute of fetchtorrent. aleksana2024-07-041-1/+1
* doc: add stdenv passthru chapter (#315909)•••* doc: add stdenv passthru chapter Broad strokes: - create the chapter - move existing stdenv passthru coverage into it - move out-of-place coverage of passthru.tests from the stdenv meta chapter into it - (try to) apply 1-sentence-per-line to text I've touched - add legacy anchors for everything moved - update existing links to the new anchors - add tentative motivating text - make nixpkgs-internal links relative/branchless razor: if it is only ever needed by contributors, which is likely if links refer to the latest revision of the source code, then it's for the contributor guide Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>Travis A. Everett2024-06-111-3/+3
* doc: update fetchzip docs, add examples and follow conventions•••With updates in a doc team meeting with Valentin, Silvan and Johannes :) DS2024-04-111-10/+150
* doc: document fetchurl more completely, follow doc conventions (#300429)•••* doc: document fetchurl more completely, follow doc conventions Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>Daniel Sidhion2024-04-041-13/+371
* doc: improve fetchers overview, deduplicate readme content, follow doc conven...•••* doc: improve fetchers overview, deduplicate readme content * Improve caveat explanation and some fetchurl content * move out consumer docs on source fetching * move note on mirror URLs to the relevant section this may be better suited for the `fetchurl` reference, but it's probably better to just render that information into the manual. for now, because - contributor documentation encourages mirrors - we can expect contributors to dig into the source - linking source files is trivial in in-code documentation we leave it there. * move instructions for updating hashes to the manual * Add more clarity on text, reorganise source hash methods --------- Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Dominic Mills-Howell <dominic.millz27@gmail.com> Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>Daniel Sidhion2024-04-031-37/+132
* treewide: Switch markdown placeholder from "..." to <...>•••We use angle brackets since they look a lot like a placeholder while also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970 Janne Heß2024-03-281-1/+1
* treewide: Fix all Nix ASTs in all markdown files•••This allows for correct highlighting and maybe future automatic formatting. The AST was verified to work with nixfmt only. Janne Heß2024-03-281-5/+5
* treewide: Mark Nix blocks in markdown as Nix•••This should help us with highlighting and future formatting. Janne Heß2024-03-281-2/+2
* trivial-builders: Deduplicate docs•••I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation. Robert Hensing2024-03-111-0/+4
* doc/fetchers: document downloadToTemp for fetchurl (#288762)•••* doc/fetchers: document downloadToTemp for fetchurl Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>Matthieu Coudron2024-02-221-0/+4
* doc: builders -> build helpers to reduce ambigualtyYueh-Shun Li2023-11-071-0/+283