MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

bitbake: doc: bitbake-user-manual: Document BB_GIT_SHALLOW and friends

Browse Source 
Documentation is based on the commit message of bitbake rev 5ed7d85fda
and mailing list discussion.

[YOCTO #14493]

(Bitbake rev: a183322ef56c64c97aa2b72fedcdf58e29dbb3cf)

Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Barker 2021-10-21 18:22:26 +02:00 committed by Richard Purdie
parent 75e63f41a8
commit 5933782d2b
1 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
View File

@ -281,6 +281,62 @@ overview of their function and contents.
BB_GENERATE_MIRROR_TARBALLS = "1"
:term:`BB_GENERATE_SHALLOW_TARBALLS`
Setting this variable to "1" when :term:`BB_GIT_SHALLOW` is also set to
"1" causes bitbake to generate shallow mirror tarballs when fetching git
repositories. The number of commits included in the shallow mirror
tarballs is controlled by :term:`BB_GIT_SHALLOW_DEPTH`.
If both :term:`BB_GIT_SHALLOW` and :term:`BB_GENERATE_MIRROR_TARBALLS` are
enabled, bitbake will generate shallow mirror tarballs by default for git
repositories. This separate variable exists so that shallow tarball
generation can be enabled without needing to also enable normal mirror
generation if it is not desired.
For example usage, see :term:`BB_GIT_SHALLOW`.
: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.
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
try to fetch the full mirror tarball and use that.
When a mirror tarball is not available, a full git clone will be performed
regardless of whether this variable is set or not. Support for shallow
clones is not currently implemented as git does not directly support
shallow cloning a particular git commit hash (it only supports cloning
from a tag or branch reference).
See also :term:`BB_GIT_SHALLOW_DEPTH` and
:term:`BB_GENERATE_SHALLOW_TARBALLS`.
Example usage::
BB_GIT_SHALLOW ?= "1"
# Keep only the top commit
BB_GIT_SHALLOW_DEPTH ?= "1"
# This defaults to enabled if both BB_GIT_SHALLOW and
# BB_GENERATE_MIRROR_TARBALLS are enabled
BB_GENERATE_SHALLOW_TARBALLS ?= "1"
:term:`BB_GIT_SHALLOW_DEPTH`
When used with :term:`BB_GENERATE_SHALLOW_TARBALLS`, this variable sets
the number of commits to include in generated shallow mirror tarballs.
With a depth of 1, only the commit referenced in :term:`SRCREV` is
included in the shallow mirror tarball. Increasing the depth includes
additional parent commits, working back through the commit history.
If this variable is unset, bitbake will default to a depth of 1 when
generating shallow mirror tarballs.
For example usage, see :term:`BB_GIT_SHALLOW`.
:term:`BB_HASHBASE_WHITELIST`
Lists variables that are excluded from checksum and dependency data.
Variables that are excluded can therefore change without affecting