diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Wrap-dependency-system-manual.md | 8 | ||||
| -rw-r--r-- | docs/markdown/snippets/depth.md | 7 |
2 files changed, 15 insertions, 0 deletions
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md index 619492a..22ba589 100644 --- a/docs/markdown/Wrap-dependency-system-manual.md +++ b/docs/markdown/Wrap-dependency-system-manual.md @@ -143,6 +143,14 @@ automatically by adding the following *(since 0.48.0)*: clone-recursive = true ``` +Setting the clone depth is supported using the `depth` directive *(since 0.52.0)*. +Note that git always allow shallowly cloning branches, but in order to clone commit ids +shallowly, the server must support `uploadpack.allowReachableSHA1InWant=true`. + +```ini +depth = 1 +``` + ## Using wrapped projects Wraps provide a convenient way of obtaining a project into your subproject directory. diff --git a/docs/markdown/snippets/depth.md b/docs/markdown/snippets/depth.md new file mode 100644 index 0000000..bdb032c --- /dev/null +++ b/docs/markdown/snippets/depth.md @@ -0,0 +1,7 @@ +## Add `depth` option to `wrap-git` + +To allow shallow cloning, an option `depth` has been added to `wrap-git`. +This applies recursively to submodules when `clone-recursive` is set to `true`. + +Note that the git server may have to be configured to support shallow cloning +not only for branches but also for tags. |