summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorWinter <winter@winter.cafe>2022-08-04 15:26:03 -0400
committerRick van Schijndel <Mindavi@users.noreply.github.com>2022-08-14 23:03:07 +0200
commitdbd18a63a7e8bb59efa9e556241786ac2169033a (patch)
treedf645807f0065b6c3d21ac78cba20406b7fa27e5 /doc
parent989b7550e6f2b65230f64233a0216cce4ec6ddf8 (diff)
fetchgit: allow disabling cone mode for sparse checkouts, fix test
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/fetchers.chapter.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/builders/fetchers.chapter.md b/doc/builders/fetchers.chapter.md
index 947afe8e9fdb6..12d8a5d887fd4 100644
--- a/doc/builders/fetchers.chapter.md
+++ b/doc/builders/fetchers.chapter.md
@@ -91,7 +91,7 @@ Used with Git. Expects `url` to a Git repo, `rev`, and `sha256`. `rev` in this c
 
 Additionally, the following optional arguments can be given: `fetchSubmodules = true` makes `fetchgit` also fetch the submodules of a repository. If `deepClone` is set to true, the entire repository is cloned as opposing to just creating a shallow clone. `deepClone = true` also implies `leaveDotGit = true` which means that the `.git` directory of the clone won't be removed after checkout.
 
-If only parts of the repository are needed, `sparseCheckout` can be used. This will prevent git from fetching unnecessary blobs from server, see [git sparse-checkout](https://git-scm.com/docs/git-sparse-checkout) and [git clone --filter](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---filterltfilter-specgt) for more information:
+If only parts of the repository are needed, `sparseCheckout` can be used. This will prevent git from fetching unnecessary blobs from server, see [git sparse-checkout](https://git-scm.com/docs/git-sparse-checkout) for more information:
 
 ```nix
 { stdenv, fetchgit }:
@@ -101,8 +101,8 @@ stdenv.mkDerivation {
   src = fetchgit {
     url = "https://...";
     sparseCheckout = ''
-      path/to/be/included
-      another/path
+      directory/to/be/included
+      another/directory
     '';
     sha256 = "0000000000000000000000000000000000000000000000000000";
   };