From 92b07bd4ab7a2838899399f81a2a10efc609baf1 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 22 Jul 2025 13:41:27 +0200 Subject: [PATCH] bitbake: doc/bitbake-user-manual-fetching: update the Git fetcher tag description After commit d591d7633fe8 ("fetch/git: Rework tag parameter handling"), update the description of the tag= parameter for the Git fetcher. (Bitbake rev: 85b31a55d114a1430868233d56573b470fef8908) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- .../bitbake-user-manual-fetching.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 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 4762d2637a..f357765b77 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst @@ -439,10 +439,12 @@ This fetcher supports the following parameters: - *"rev":* The revision to use for the checkout. If :term:`SRCREV` is also set, this parameter must match its value. -- *"tag":* Specifies a tag to use for the checkout. To correctly - resolve tags, BitBake must access the network. For that reason, tags - are often not used. As far as Git is concerned, the "tag" parameter - behaves effectively the same as the "rev" parameter. +- *"tag":* Specifies a tag to use when fetching. To correctly resolve + tags, BitBake must access the network. If a ``rev`` parameter or + :term:`SRCREV` is also specified, network access is not necessary to resolve + the tag and instead, it is verified that they both resolve to the same commit + SHA at unpack time. The ``tag`` parameter is optional, but strongly + recommended if the checked out revision is a tag. - *"subpath":* Limits the checkout to a specific subpath of the tree. By default, the whole tree is checked out.