[PATCH 1/2] doc: bitbake-user-manual: add branch parameter to git SRC_URI examples

[PATCH 1/2] doc: bitbake-user-manual: add branch parameter to git SRC_URI examples

[Michael Opdenacker]

This parameter is now required by the git fetcher module

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-fetching.rst  | 8 ++++----
 .../bitbake-user-manual-ref-variables.rst                 | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 9ff4e161..ae2d3a17 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -405,7 +405,7 @@ This fetcher supports the following parameters:
      ``git@gitlab.freedesktop.org:mesa/mesa.git``, however the expected URL in
      :term:`SRC_URI` is the following::
 
-       SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;protocol=ssh;..."
+       SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;branch=master;protocol=ssh;..."
 
      Note the ``:`` character changed for a ``/`` before the path to the project.
 
@@ -457,9 +457,9 @@ This fetcher supports the following parameters:
 
 Here are some example URLs::
 
-   SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"
-   SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http"
-   SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;protocol=ssh;..."
+   SRC_URI = "git://git.oe.handhelds.org/git/vip.git;branch=master;tag=version-1"
+   SRC_URI = "git://git.oe.handhelds.org/git/vip.git;branch=master;protocol=http"
+   SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;branch=master;protocol=ssh;..."
 
 .. note::
 
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 59a9de2f..c89503c8 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1413,8 +1413,8 @@ overview of their function and contents.
          :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one
          file or git repository specified in :term:`SRC_URI`. For example::
 
-            SRC_URI = "git://example.com/foo.git;name=first \
-                       git://example.com/bar.git;name=second \
+            SRC_URI = "git://example.com/foo.git;branch=master;name=first \
+                       git://example.com/bar.git;branch=master;name=second \
                        http://example.com/file.tar.gz;name=third"
 
             SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
-- 
2.25.1

[PATCH 2/2] doc: bitbake-user-manual: branch parameter now mandatory in git SRC_URIs

[Michael Opdenacker]

Signed-off-by: Michael Opdenacker <michael.opdenacker@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 ae2d3a17..d0c78062 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -432,8 +432,8 @@ This fetcher supports the following parameters:
    raw Git metadata is provided. This parameter implies the "nocheckout"
    parameter as well.
 
--  *"branch":* The branch(es) of the Git tree to clone. If unset, this
-   is assumed to be "master". The number of branch parameters much match
+-  *"branch":* The branch(es) of the Git tree to clone. 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
-- 
2.25.1

RE: [docs] [PATCH 2/2] doc: bitbake-user-manual: branch parameter now mandatory in git SRC_URIs

[Peter Kjellerstedt]

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf
> Of Michael Opdenacker via lists.yoctoproject.org
> Sent: den 9 mars 2022 18:53
> To: bitbake-devel@lists.openembedded.org
> Cc: docs@lists.yoctoproject.org; Michael Opdenacker
> <michael.opdenacker@bootlin.com>
> Subject: [docs] [PATCH 2/2] doc: bitbake-user-manual: branch parameter now
> mandatory in git SRC_URIs
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@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 ae2d3a17..d0c78062 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
> @@ -432,8 +432,8 @@ This fetcher supports the following parameters:
>     raw Git metadata is provided. This parameter implies the "nocheckout"
>     parameter as well.
> 
> --  *"branch":* The branch(es) of the Git tree to clone. If unset, this
> -   is assumed to be "master". The number of branch parameters much match
> +-  *"branch":* The branch(es) of the Git tree to clone. This is a
> +   mandatory parameter. The number of branch parameters must match
>     the number of name parameters.

Note that it is either branch=... or nobranch=1 that is mandatory.

> 
>  -  *"rev":* The revision to use for the checkout. The default is
> --
> 2.25.1

//Peter

Re: [docs] [PATCH 2/2] doc: bitbake-user-manual: branch parameter now mandatory in git SRC_URIs

[Michael Opdenacker]

Hi Peter,

On 3/10/22 11:53, Peter Kjellerstedt wrote:
>>
>> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
>> b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
>> index ae2d3a17..d0c78062 100644
>> --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
>> +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
>> @@ -432,8 +432,8 @@ This fetcher supports the following parameters:
>>     raw Git metadata is provided. This parameter implies the "nocheckout"
>>     parameter as well.
>>
>> --  *"branch":* The branch(es) of the Git tree to clone. If unset, this
>> -   is assumed to be "master". The number of branch parameters much match
>> +-  *"branch":* The branch(es) of the Git tree to clone. This is a
>> +   mandatory parameter. The number of branch parameters must match
>>     the number of name parameters.
> Note that it is either branch=... or nobranch=1 that is mandatory.


Oops, indeed. Thanks for the correction.
Sending a V2 right now...
Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com