diff mbox series

[wrynose,2.18,1/3] doc: Fix description of git shallow mirror tarball creation

Message ID a771d90e1e521f691ceaac519216bfa8b9ea5686.1778197991.git.yoann.congal@smile.fr
State New
Headers show
Series [wrynose,2.18,1/3] doc: Fix description of git shallow mirror tarball creation | expand

Commit Message

Yoann Congal May 8, 2026, 7:13 a.m. UTC 
From: Paul Barker <paul@pbarker.dev>

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit a7acbfd454c1ce33e32e09a23d4573e06b44e835)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 .../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 8d8e8b8b9..9824b58ef 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