-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11908 from Mic92/pull-request
document shallow clone options in git fetchers
- Loading branch information
Showing
1 changed file
with
3 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -245,6 +245,9 @@ Currently the `type` attribute can be one of the following: | |
* `./sub/dir` (when used on the command line and `dir/flake.nix` is in a git repository) | ||
* `git+https://example.org/my/repo` | ||
* `git+https://example.org/my/repo?dir=flake1` | ||
* `git+https://example.org/my/repo?shallow=1` A shallow clone of the repository. | ||
For large repositories, the shallow clone option can significantly speed up fresh clones compared | ||
to non-shallow clones, while still providing faster updates than other fetch methods such as `tarball:` or `github:`. | ||
* `git+ssh://[email protected]/NixOS/nix?ref=v1.2.3` | ||
* `git://github.com/edolstra/dwarffs?ref=unstable&rev=e486d8d40e626a20e06d792db8cc5ac5aba9a5b4` | ||
* `git+file:///home/my-user/some-repo/some-repo` | ||
|