summaryrefslogtreecommitdiff
path: root/doc/build-helpers/fetchers.chapter.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/build-helpers/fetchers.chapter.md')
-rw-r--r--doc/build-helpers/fetchers.chapter.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/build-helpers/fetchers.chapter.md b/doc/build-helpers/fetchers.chapter.md
index 5ee1d78501ca..6a6ebe9013c2 100644
--- a/doc/build-helpers/fetchers.chapter.md
+++ b/doc/build-helpers/fetchers.chapter.md
@@ -829,6 +829,10 @@ Additionally, the following optional arguments can be given:
See [git sparse-checkout](https://git-scm.com/docs/git-sparse-checkout) for more information.
+*`rootDir`* (String)
+
+: When not empty, copy only contents of the subdirectory of the repository to the result. Automatically sets `sparseCheckout` and `nonConeMode` to avoid checking out any extra pieces. Incompatible with `leaveDotGit`.
+
Some additional parameters for niche use-cases can be found listed in the function parameters in the declaration of `fetchgit`: `pkgs/build-support/fetchgit/default.nix`.
Future parameters additions might also happen without immediately being documented here.