Bug 15757 - BB_GIT_SHALLOW_EXTRA_REFS, BB_GIT_SHALLOW_REVS and BB_GIT_NOSHARED variable are not documented
Summary: BB_GIT_SHALLOW_EXTRA_REFS, BB_GIT_SHALLOW_REVS and BB_GIT_NOSHARED variable a...
Status: NEW
Alias: None
Product: BitBake
Classification: Build System, Metadata & Runtime
Component: bitbake (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium normal
Target Milestone: 6.99
Assignee: Antonin Godard
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2025-02-16 10:19 UTC by kweihmann
Modified: 2025-12-05 15:27 UTC (History)
3 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description kweihmann 2025-02-16 10:19:16 UTC 
The following variable are used by bitbake's git fetcher code.

BB_GIT_SHALLOW
BB_GIT_SHALLOW_DEPTH
BB_GIT_SHALLOW_EXTRA_REFS
BB_GIT_SHALLOW_REVS
BB_GIT_NOSHARED

Out of them none of them comes with a sane default value (e.g. empty), so e.g.

> bitbake-getvar BB_GIT_SHALLOW

returns

> The variable 'BB_GIT_SHALLOW' is not defined

In addition BB_GIT_SHALLOW_EXTRA_REFS, BB_GIT_SHALLOW_REVS and BB_GIT_NOSHARED
are not documented at all
Comment 1 Richard Purdie 2025-02-17 12:56:23 UTC 
As per several other bugs opened of this type, we are not adding default values for the sake of it.

I do agree we should document variables where possible.