summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaximilian Bosch <maximilian@mbosch.me>2020-09-08 19:45:28 +0200
committerMaximilian Bosch <maximilian@mbosch.me>2020-12-22 12:02:08 +0100
commite54971d019821dd213db028a80cd5fca85ee2ed6 (patch)
treee1f000d3eff6a990cdd8dac0264f5d0c79565532
parent2857b1baaf78bbadeec01adfae8a50fc0f2a254f (diff)
Document `allRefs` argument of `builtins.fetchTree`
-rw-r--r--src/libexpr/primops/fetchTree.cc5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libexpr/primops/fetchTree.cc b/src/libexpr/primops/fetchTree.cc
index 6e7ddde8e..133299030 100644
--- a/src/libexpr/primops/fetchTree.cc
+++ b/src/libexpr/primops/fetchTree.cc
@@ -324,6 +324,11 @@ static RegisterPrimOp primop_fetchGit({
A Boolean parameter that specifies whether submodules should be
checked out. Defaults to `false`.
+ - allRefs
+ Whether to fetch all refs of the repository. With this argument being
+ true, it's possible to load a `rev` from *any* `ref` (by default only
+ `rev`s from the specified `ref` are supported).
+
Here are some examples of how to use `fetchGit`.
- To fetch a private repository over SSH: