diff mbox series

[2/2] doc: Fix description of git shallow mirror tarball creation

Message ID 20260424-make-shallow-v1-2-fc06b12ca344@pbarker.dev
State New
Headers show
Series Drop git-make-shallow and update docs | expand

Commit Message

Paul Barker April 24, 2026, 12:47 p.m. UTC 
The method used to create shallow tarballs was changed back in 2024, but
the associated documentation was not updated.

Fixes: a5a569c07522 ("fetch2/git: Use git shallow fetch to implement clone_shallow_local()")
Signed-off-by: Paul Barker <paul@pbarker.dev>
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 8d8e8b8b912d..9824b58ef274 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -349,8 +349,9 @@  overview of their function and contents.
    :term:`BB_GIT_SHALLOW`
       Setting this variable to "1" enables the support for fetching, using and
       generating mirror tarballs of `shallow git repositories <https://riptutorial.com/git/example/4584/shallow-clone>`_.
-      The external `git-make-shallow <https://git.openembedded.org/bitbake/tree/bin/git-make-shallow>`_
-      script is used for shallow mirror tarball creation.
+      A git shallow fetch is used for shallow mirror tarball creation (i.e.
+      ``git fetch --depth <depth> ...`` or
+      ``git fetch --shallow-exclude=<revs> ...``.
 
       When :term:`BB_GIT_SHALLOW` is enabled, bitbake will attempt to fetch a shallow
       mirror tarball. If the shallow mirror tarball cannot be fetched, it will