| Message ID | 20250718-new-tag-git-fetcher-v2-2-11240d481a05@bootlin.com |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | Update the Git fetcher tag and rev descriptions | expand |
Hi Antonin, On 7/18/25 11:06 AM, Antonin Godard wrote: > Remove rev's "master" default value. Mention that it must match SRCREV, > if set. > > Reported-by: Quentin Schulz <quentin.schulz@cherry.de> > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> > --- > doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst > index 51c9a81e03..d4496a9fb7 100644 > --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst > +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst > @@ -436,8 +436,8 @@ This fetcher supports the following parameters: > "nobranch" is set to "1", this is a mandatory parameter. The number of > branch parameters must match the number of name parameters. > > -- *"rev":* The revision to use for the checkout. The default is > - "master". > +- *"rev":* The revision to use for the checkout. If :term:`SRCREV` is also set, > + this parameter must match its value. > This seems correct to me. There's a second occurrence of that rev parameter in the docs for svn, so we should probably document that as well. Funnily enough, the svn fetcher has the same logic as the git fetcher except that it overrides the revision with the one from the rev= parameter, but the SRCREV != rev param is still performed as well as checking for a tag. Anyway, would be nice to update the description for the svn fetcher too! Cheers, Quentin
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst index 51c9a81e03..d4496a9fb7 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst @@ -436,8 +436,8 @@ This fetcher supports the following parameters: "nobranch" is set to "1", this is a mandatory parameter. The number of branch parameters must match the number of name parameters. -- *"rev":* The revision to use for the checkout. The default is - "master". +- *"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 match against the supplied revision (``rev=``). This does not replace the ``rev`` parameter: the ``tag`` parameter should
Remove rev's "master" default value. Mention that it must match SRCREV, if set. Reported-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)