diff mbox series

[v2,2/4] bitbake-user-manual: Add documentation for BB_GIT_SHALLOW_FAST

Message ID 20250214155057.1748020-2-stefan-koch@siemens.com
State New
Headers show
Series [v2,1/4] fetch2/git: Add support for fast initial shallow fetch | expand

Commit Message

Stefan Koch Feb. 14, 2025, 3:50 p.m. UTC
Signed-off-by: Stefan Koch <stefan-koch@siemens.com>
---
 .../bitbake-user-manual-ref-variables.rst       | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Antonin Godard Feb. 14, 2025, 4:22 p.m. UTC | #1
Hi Stefan,

On Fri Feb 14, 2025 at 4:50 PM CET, Stefan via lists.openembedded.org Koch wrote:
> Signed-off-by: Stefan Koch <stefan-koch@siemens.com>
> ---
>  .../bitbake-user-manual-ref-variables.rst       | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>
> 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 ad219b531..bba6cbcd9 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -347,6 +347,23 @@ overview of their function and contents.
>  
>        For example usage, see :term:`BB_GIT_SHALLOW`.
>  
> +   :term:`BB_GIT_SHALLOW_FAST`
> +      Set to "1" for a fast initial shallow fetch.
> +      This setting prefers an initial shallow clone
> +      over an initial full bare clone.
> +      The amount of data transferred during the initial clone will be reduced.
> +      `BB_GIT_SHALLOW` does not need to be set additionally,
> +      as `BB_GIT_SHALLOW_FAST` takes precedence over it.

Instead of `BB_GIT_SHALLOW_FAST` you can re-use :term:`BB_GIT_SHALLOW_FAST`
since you created the definition for it. Using single ticks (`...`) will make
that appear in italic otherwise.

Same for BB_GIT_SHALLOW, you can use :term:`BB_GIT_SHALLOW`.

> +
> +      However, for updates, the data transfer may be significantly
> +      higher due to fully new shallow clones.
> +      Over time, numerous shallow clones may cumulatively
> +      transfer the same amount of data as the initial full bare clone.
> +      This is especially the case with very large repositories.
> +
> +      Existing initial full bare clones, created without this fast option,
> +      will always be utilized.

I would rephrase "will always be utilized" to "will always be prioritized over
the shallow clones". If I understood that correctly?

Antonin
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 ad219b531..bba6cbcd9 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -347,6 +347,23 @@  overview of their function and contents.
 
       For example usage, see :term:`BB_GIT_SHALLOW`.
 
+   :term:`BB_GIT_SHALLOW_FAST`
+      Set to "1" for a fast initial shallow fetch.
+      This setting prefers an initial shallow clone
+      over an initial full bare clone.
+      The amount of data transferred during the initial clone will be reduced.
+      `BB_GIT_SHALLOW` does not need to be set additionally,
+      as `BB_GIT_SHALLOW_FAST` takes precedence over it.
+
+      However, for updates, the data transfer may be significantly
+      higher due to fully new shallow clones.
+      Over time, numerous shallow clones may cumulatively
+      transfer the same amount of data as the initial full bare clone.
+      This is especially the case with very large repositories.
+
+      Existing initial full bare clones, created without this fast option,
+      will always be utilized.
+
    :term:`BB_GLOBAL_PYMODULES`
       Specifies the list of Python modules to place in the global namespace.
       It is intended that only the core layer should set this and it is meant