diff options
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 858de63477..dd8cf2409a 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
@@ -320,11 +320,26 @@ overview of their function and contents. | |||
320 | mirror tarball. If the shallow mirror tarball cannot be fetched, it will | 320 | mirror tarball. If the shallow mirror tarball cannot be fetched, it will |
321 | try to fetch the full mirror tarball and use that. | 321 | try to fetch the full mirror tarball and use that. |
322 | 322 | ||
323 | When a mirror tarball is not available, a full git clone will be performed | 323 | This setting causes an initial shallow clone instead of an initial full bare clone. |
324 | regardless of whether this variable is set or not. Support for shallow | 324 | The amount of data transferred during the initial clone will be significantly reduced. |
325 | clones is not currently implemented as git does not directly support | 325 | |
326 | shallow cloning a particular git commit hash (it only supports cloning | 326 | However, every time the source revision (referenced in :term:`SRCREV`) |
327 | from a tag or branch reference). | 327 | changes, regardless of whether the cache within the download directory |
328 | (defined by :term:`DL_DIR`) has been cleaned up or not, | ||
329 | the data transfer may be significantly higher because entirely | ||
330 | new shallow clones are required for each source revision change. | ||
331 | |||
332 | Over time, numerous shallow clones may cumulatively transfer | ||
333 | the same amount of data as an initial full bare clone. | ||
334 | This is especially the case with very large repositories. | ||
335 | |||
336 | Existing initial full bare clones, created without this setting, | ||
337 | will still be utilized. | ||
338 | |||
339 | If the Git error "Server does not allow request for unadvertised object" | ||
340 | occurs, an initial full bare clone is fetched automatically. | ||
341 | This may happen if the Git server does not allow the request | ||
342 | or if the Git client has issues with this functionality. | ||
328 | 343 | ||
329 | See also :term:`BB_GIT_SHALLOW_DEPTH` and | 344 | See also :term:`BB_GIT_SHALLOW_DEPTH` and |
330 | :term:`BB_GENERATE_SHALLOW_TARBALLS`. | 345 | :term:`BB_GENERATE_SHALLOW_TARBALLS`. |