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

Message ID 20220309175319.620707-2-michael.opdenacker@bootlin.com
State New
Headers show
Series [1/2] doc: bitbake-user-manual: add branch parameter to git SRC_URI examples | expand

Commit Message

Michael Opdenacker March 9, 2022, 5:53 p.m. UTC
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(-)

Comments

Peter Kjellerstedt March 10, 2022, 10:53 a.m. UTC | #1
> -----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
Michael Opdenacker March 10, 2022, 4:38 p.m. UTC | #2
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.

Patch

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