diff options
| author | Philip Withnall <pwithnall@endlessos.org> | 2022-07-13 14:02:28 +0100 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2022-07-13 08:14:41 -0700 |
| commit | 69131e724269b3ada3a9058a2f1722ddd0617583 (patch) | |
| tree | 1a690fc1c384db782b1650f5fa7a2665238909f6 | |
| parent | 46793145ba172abb80cc69c828505b071b62685e (diff) | |
| download | meson-69131e724269b3ada3a9058a2f1722ddd0617583.zip meson-69131e724269b3ada3a9058a2f1722ddd0617583.tar.gz meson-69131e724269b3ada3a9058a2f1722ddd0617583.tar.bz2 | |
docs: Suggest using depth=1 by default for wrap-git
It saves bandwidth and disk usage on downloaded subprojects, and people
very rarely need more than the single commit they’re using.
Add `depth=1` to the `[wrap-git]` examples in the rest of the
documentation, to make it more likely that people will copy-and-paste it
into their `.wrap` files.
Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
| -rw-r--r-- | docs/markdown/Wrap-dependency-system-manual.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md index 314cd1f..c8b91d5 100644 --- a/docs/markdown/Wrap-dependency-system-manual.md +++ b/docs/markdown/Wrap-dependency-system-manual.md @@ -67,6 +67,7 @@ An example wrap-git will look like this: [wrap-git] url = https://github.com/libfoobar/libfoobar.git revision = head +depth = 1 ``` ## Accepted configuration properties for wraps @@ -115,7 +116,8 @@ of downloading the file, even if `--wrap-mode` option is set to (for git) `head` to track upstream's default branch. Required. ### Specific to wrap-git -- `depth` - shallowly clone the repository to X number of commits. Note +- `depth` - shallowly clone the repository to X number of commits. This saves bandwidth and disk + space, and should typically always be specified unless commit history is needed. Note that git always allow shallowly cloning branches, but in order to clone commit ids shallowly, the server must support `uploadpack.allowReachableSHA1InWant=true`. *(since 0.52.0)* @@ -249,6 +251,7 @@ and `gio-2.0`, a wrap file would look like: [wrap-git] url=https://gitlab.gnome.org/GNOME/glib.git revision=glib-2-62 +depth=1 [provide] dependency_names = glib-2.0, gobject-2.0, gio-2.0 @@ -261,6 +264,7 @@ specified: [wrap-git] url=https://gitlab.gnome.org/GNOME/glib.git revision=glib-2-62 +depth=1 [provide] glib-2.0=glib_dep |