summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2023-09-02 11:54:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-09-05 08:13:13 +0100
commitf066aee59806e6123886bd6ace04319bd5f38bf1 (patch)
treee4079685ed0e632b0a89d18c0f1fdc4aeb45da4c
parente42e2cfc12724b26fe77c8b314895173b5b52e73 (diff)
downloadpoky-f066aee59806e6123886bd6ace04319bd5f38bf1.tar.gz
bitbake: doc: Document challenges of tags with git fetcher
Using tags with the git fetcher may cause surprising behaviour. There are reasons for this, document them. (Bitbake rev: 56224da378ab63526d44fd7a70bcfd2cffe245cc) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index f5723d6767..c905288c48 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -476,6 +476,14 @@ Here are some example URLs::
476 easy to share metadata without removing passwords. SSH keys, ``~/.netrc`` 476 easy to share metadata without removing passwords. SSH keys, ``~/.netrc``
477 and ``~/.ssh/config`` files can be used as alternatives. 477 and ``~/.ssh/config`` files can be used as alternatives.
478 478
479Using tags with the git fetcher may cause surprising behaviour. Bitbake needs to
480resolve the tag to a specific revision and to do that, it has to connect to and use
481the upstream repository. This is because the revision the tags point at can change and
482we've seen cases of this happening in well known public repositories. This can mean
483many more network connections than expected and recipes may be reparsed at every build.
484Source mirrors will also be bypassed as the upstream repository is the only source
485of truth to resolve the revision accurately. For these reasons, whilst the fetcher
486can support tags, we recommend being specific about revisions in recipes.
479 487
480.. _gitsm-fetcher: 488.. _gitsm-fetcher:
481 489