aboutsummaryrefslogtreecommitdiffstats
path: root/doc
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:12:26 +0100
commit56224da378ab63526d44fd7a70bcfd2cffe245cc (patch)
tree4196d2d55c08a0231b775e45e1115a88cc1801a9 /doc
parent5625849e9327fc71a38eea00d4506f80abc11bc6 (diff)
downloadbitbake-56224da378ab63526d44fd7a70bcfd2cffe245cc.tar.gz
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. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index f5723d676..c905288c4 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -476,6 +476,14 @@ Here are some example URLs::
easy to share metadata without removing passwords. SSH keys, ``~/.netrc``
and ``~/.ssh/config`` files can be used as alternatives.
+Using tags with the git fetcher may cause surprising behaviour. Bitbake needs to
+resolve the tag to a specific revision and to do that, it has to connect to and use
+the upstream repository. This is because the revision the tags point at can change and
+we've seen cases of this happening in well known public repositories. This can mean
+many more network connections than expected and recipes may be reparsed at every build.
+Source mirrors will also be bypassed as the upstream repository is the only source
+of truth to resolve the revision accurately. For these reasons, whilst the fetcher
+can support tags, we recommend being specific about revisions in recipes.
.. _gitsm-fetcher: