[PATCH] Add clarification for SRCREV

[PATCH] Add clarification for SRCREV

[Ed Beroset]

It was not clear to me what a "full revision identifier" was in the
context of the note documenting SRCREV.  After clarification via IRC,
this submission attempts to clarify what is meant to help future
readers.

Signed-off-by: Ed Beroset <beroset@ieee.org>
---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6a7888ab4..5b96e4efe 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7942,7 +7942,7 @@ system and gives an overview of their function and contents.
       that if you want to build a fixed revision and you want to avoid
       performing a query on the remote repository every time BitBake parses
       your recipe, you should specify a :term:`SRCREV` that is a full revision
-      identifier and not just a tag.
+      identifier (e.g. the full SHA hash in git) and not just a tag.
 
       .. note::
 
-- 
2.40.1

Re: [docs] [PATCH] Add clarification for SRCREV

[Michael Opdenacker]

Hi Ed

On 06.06.23 at 20:09, Ed Beroset via lists.yoctoproject.org wrote:
> It was not clear to me what a "full revision identifier" was in the
> context of the note documenting SRCREV.  After clarification via IRC,
> this submission attempts to clarify what is meant to help future
> readers.
>
> Signed-off-by: Ed Beroset <beroset@ieee.org>
> ---
>   documentation/ref-manual/variables.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6a7888ab4..5b96e4efe 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7942,7 +7942,7 @@ system and gives an overview of their function and contents.
>         that if you want to build a fixed revision and you want to avoid
>         performing a query on the remote repository every time BitBake parses
>         your recipe, you should specify a :term:`SRCREV` that is a full revision
> -      identifier and not just a tag.
> +      identifier (e.g. the full SHA hash in git) and not just a tag.
>   
>         .. note::


Many thanks for the patch!
Everything looks good, except that your patch is received through "Your 
Name via lists.openembedded.org" or "Your Name via 
lists.yoctoproject.org". We'd need you to do add one thing to your git 
configuration, so that your patches are given an "Author" field which 
matches your "Signed-off-by" information. See 
https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded#Fixing_your_From_identity 
for details.

Don't hesitate to send a patch test directly to me, if you wish.
Thanks in advance
Michael.

-- 

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

[PATCH] Add clarification for SRCREV

[beroset]

From: Ed Beroset <beroset@ieee.org>

It was not clear to me what a "full revision identifier" was in the
context of the note documenting SRCREV.  After clarification via IRC,
this submission attempts to clarify what is meant to help future
readers.

Signed-off-by: Ed Beroset <beroset@ieee.org>
---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6a7888ab4..5b96e4efe 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7942,7 +7942,7 @@ system and gives an overview of their function and contents.
       that if you want to build a fixed revision and you want to avoid
       performing a query on the remote repository every time BitBake parses
       your recipe, you should specify a :term:`SRCREV` that is a full revision
-      identifier and not just a tag.
+      identifier (e.g. the full SHA hash in git) and not just a tag.
 
       .. note::
 
-- 
2.40.1

Re: [docs] [PATCH] Add clarification for SRCREV

[Michael Opdenacker]

Hi Ed,

On 07.06.23 at 15:58, Ed Beroset via lists.yoctoproject.org wrote:
> From: Ed Beroset <beroset@ieee.org>
>
> It was not clear to me what a "full revision identifier" was in the
> context of the note documenting SRCREV.  After clarification via IRC,
> this submission attempts to clarify what is meant to help future
> readers.
>
> Signed-off-by: Ed Beroset <beroset@ieee.org>
> ---
>   documentation/ref-manual/variables.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6a7888ab4..5b96e4efe 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7942,7 +7942,7 @@ system and gives an overview of their function and contents.
>         that if you want to build a fixed revision and you want to avoid
>         performing a query on the remote repository every time BitBake parses
>         your recipe, you should specify a :term:`SRCREV` that is a full revision
> -      identifier and not just a tag.
> +      identifier (e.g. the full SHA hash in git) and not just a tag.
>   
>         .. note::


Thanks for this update!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into master-next.

Thanks again!
Cheers
Michael.

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