summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-07-22 13:41:27 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-07-22 14:19:25 +0100
commit92b07bd4ab7a2838899399f81a2a10efc609baf1 (patch)
tree80b8f19d2af5a3886971ec3c26480fe4f29ce409
parentb0f8af26a78aa6785b3e57585e86fc668808cd84 (diff)
downloadpoky-92b07bd4ab7a2838899399f81a2a10efc609baf1.tar.gz
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 <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst10
1 files 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:
439- *"rev":* The revision to use for the checkout. If :term:`SRCREV` is also set, 439- *"rev":* The revision to use for the checkout. If :term:`SRCREV` is also set,
440 this parameter must match its value. 440 this parameter must match its value.
441 441
442- *"tag":* Specifies a tag to use for the checkout. To correctly 442- *"tag":* Specifies a tag to use when fetching. To correctly resolve
443 resolve tags, BitBake must access the network. For that reason, tags 443 tags, BitBake must access the network. If a ``rev`` parameter or
444 are often not used. As far as Git is concerned, the "tag" parameter 444 :term:`SRCREV` is also specified, network access is not necessary to resolve
445 behaves effectively the same as the "rev" parameter. 445 the tag and instead, it is verified that they both resolve to the same commit
446 SHA at unpack time. The ``tag`` parameter is optional, but strongly
447 recommended if the checked out revision is a tag.
446 448
447- *"subpath":* Limits the checkout to a specific subpath of the tree. 449- *"subpath":* Limits the checkout to a specific subpath of the tree.
448 By default, the whole tree is checked out. 450 By default, the whole tree is checked out.