diff mbox series

Add clarification for SRCREV

Message ID 20230607135831.519561-1-beroset@ieee.org
State New
Headers show
Series Add clarification for SRCREV | expand

Commit Message

Ed Beroset June 7, 2023, 1:58 p.m. UTC
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(-)

Comments

Michael Opdenacker June 7, 2023, 3:55 p.m. UTC | #1
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.
diff mbox series

Patch

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::