Document allRefs argument of builtins.fetchTree

2020-09-08 19:45:28 +02:00 · 2020-09-08 19:45:28 +02:00 · e54971d019
parent 2857b1baaf
commit e54971d019
1 changed files with 5 additions and 0 deletions
--- 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: