Bug 15757

Summary:	BB_GIT_SHALLOW_EXTRA_REFS, BB_GIT_SHALLOW_REVS and BB_GIT_NOSHARED variable are not documented
Product:	[Build System, Metadata & Runtime] BitBake	Reporter:	kweihmann
Component:	bitbake	Assignee:	Antonin Godard <antonin.godard>
Status:	NEW ---	QA Contact:
Severity:	normal
Priority:	Medium	CC:	poky.bs.watcher, poky.watcher, randy.macleod
Version:	unspecified
Target Milestone:	6.99
Hardware:	x86
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Yes (doc changes required)

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.