All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
@ 2025-02-06 21:57 Yoann Congal
  2025-02-06 21:57 ` [PATCH v2 2/3] reproducible-builds: change/add titles in the "How" section Yoann Congal
                   ` (3 more replies)
  0 siblings, 4 replies; 11+ messages in thread
From: Yoann Congal @ 2025-02-06 21:57 UTC (permalink / raw)
  To: docs; +Cc: Yoann Congal, Guillaume Swaenepoel

From: Yoann Congal <yoann.congal@smile.fr>

This documents the variable used in the "automate testing a single
recipe's reproducibility" feature [YOCTO #15701]

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 47d4e814f..32e91b6db 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5802,6 +5802,11 @@ system and gives an overview of their function and contents.
       For additional information on how this variable is used, see the
       initialization script.
 
+   :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
+      Set build target for build reproducibility testing but activate
+      :ref:`shared state <overview-manual/concepts:shared state cache>` build
+      for most dependencies. See :doc:`/test-manual/reproducible-builds`.
+
    :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE`
       Set the package manager(s) for build reproducibility testing.
       See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* [PATCH v2 2/3] reproducible-builds: change/add titles in the "How" section
  2025-02-06 21:57 [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Yoann Congal
@ 2025-02-06 21:57 ` Yoann Congal
  2025-02-06 21:57 ` [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables Yoann Congal
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 11+ messages in thread
From: Yoann Congal @ 2025-02-06 21:57 UTC (permalink / raw)
  To: docs; +Cc: Yoann Congal, Guillaume Swaenepoel

From: Yoann Congal <yoann.congal@smile.fr>

This is preparation work for the following commit.

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
---
 documentation/test-manual/reproducible-builds.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
index aaf2e4541..b9f671d68 100644
--- a/documentation/test-manual/reproducible-builds.rst
+++ b/documentation/test-manual/reproducible-builds.rst
@@ -122,9 +122,12 @@ The project's current reproducibility status can be seen at
 You can also check the reproducibility status on the Autobuilder:
 :yocto_ab:`/valkyrie/#/builders/reproducible`.
 
-===============================
-Can I test my layer or recipes?
-===============================
+===================================
+How can I test my layer or recipes?
+===================================
+
+With world build
+~~~~~~~~~~~~~~~~
 
 Once again, you can run a ``world`` test using the
 :ref:`oe-selftest <ref-manual/release-process:Testing and Quality Assurance>`
@@ -132,6 +135,9 @@ command provided above. This functionality is implemented
 in :oe_git:`meta/lib/oeqa/selftest/cases/reproducible.py
 </openembedded-core/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`.
 
+Subclassing the test
+~~~~~~~~~~~~~~~~~~~~
+
 You could subclass the test and change ``targets`` to a different target.
 
 You may also change ``sstate_targets`` which would allow you to "pre-cache" some


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables
  2025-02-06 21:57 [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Yoann Congal
  2025-02-06 21:57 ` [PATCH v2 2/3] reproducible-builds: change/add titles in the "How" section Yoann Congal
@ 2025-02-06 21:57 ` Yoann Congal
  2025-02-07  9:13   ` [docs] " Quentin Schulz
  2025-02-07  8:53 ` [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Quentin Schulz
  2025-02-07  9:26 ` Antonin Godard
  3 siblings, 1 reply; 11+ messages in thread
From: Yoann Congal @ 2025-02-06 21:57 UTC (permalink / raw)
  To: docs; +Cc: Yoann Congal, Guillaume Swaenepoel

From: Yoann Congal <yoann.congal@smile.fr>

Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were
shown earlier.

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
---
v1->v2: Quentin's review
* tick-quote variable in title
* a set of recipeS
* 3 spaces to align a code block (not 4)
---
 .../test-manual/reproducible-builds.rst        | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
index b9f671d68..77c15d6e2 100644
--- a/documentation/test-manual/reproducible-builds.rst
+++ b/documentation/test-manual/reproducible-builds.rst
@@ -145,3 +145,21 @@ set of recipes before the test, meaning they are excluded from reproducibility
 testing. As a practical example, you could set ``sstate_targets`` to
 ``core-image-sato``, then setting ``targets`` to ``core-image-sato-sdk`` would
 run reproducibility tests only on the targets belonging only to ``core-image-sato-sdk``.
+
+Using `OEQA_REPRODUCIBLE_TEST_*` variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to test the reproducibility of a set of recipes, you can define
+:term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`, in your local.conf::
+
+   OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS = "my-recipe"
+
+This will test the reproducibility of ``my-recipe`` but will use the
+:ref:`Shared State <overview-manual/concepts:Shared State>` for most its
+dependencies.
+
+You can have finer control on the test with:
+
+- :term:`OEQA_REPRODUCIBLE_TEST_TARGET`: lists recipes to be built,
+- :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS`: lists recipes that will
+  be built using :ref:`Shared State <overview-manual/concepts:Shared State>`.


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
  2025-02-06 21:57 [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Yoann Congal
  2025-02-06 21:57 ` [PATCH v2 2/3] reproducible-builds: change/add titles in the "How" section Yoann Congal
  2025-02-06 21:57 ` [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables Yoann Congal
@ 2025-02-07  8:53 ` Quentin Schulz
  2025-02-09 22:59   ` Yoann Congal
  2025-02-07  9:26 ` Antonin Godard
  3 siblings, 1 reply; 11+ messages in thread
From: Quentin Schulz @ 2025-02-07  8:53 UTC (permalink / raw)
  To: yoann.congal, docs; +Cc: Guillaume Swaenepoel

Hi Yoann,

On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
> From: Yoann Congal <yoann.congal@smile.fr>
> 
> This documents the variable used in the "automate testing a single
> recipe's reproducibility" feature [YOCTO #15701]
> 
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
> ---
>   documentation/ref-manual/variables.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 47d4e814f..32e91b6db 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5802,6 +5802,11 @@ system and gives an overview of their function and contents.
>         For additional information on how this variable is used, see the
>         initialization script.
>   
> +   :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
> +      Set build target for build reproducibility testing but activate

s/target/target(s)/

based on the code that uses it in OE-Core and also the name which is in 
plural :)

Is this correct?

Cheers,
Quentin


^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables
  2025-02-06 21:57 ` [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables Yoann Congal
@ 2025-02-07  9:13   ` Quentin Schulz
  2025-02-09 22:59     ` Yoann Congal
  0 siblings, 1 reply; 11+ messages in thread
From: Quentin Schulz @ 2025-02-07  9:13 UTC (permalink / raw)
  To: yoann.congal, docs; +Cc: Guillaume Swaenepoel

Hi Yoann,

On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
> From: Yoann Congal <yoann.congal@smile.fr>
> 
> Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
> and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were
> shown earlier.
> 
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
> ---
> v1->v2: Quentin's review
> * tick-quote variable in title
> * a set of recipeS
> * 3 spaces to align a code block (not 4)
> ---
>   .../test-manual/reproducible-builds.rst        | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
> 
> diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
> index b9f671d68..77c15d6e2 100644
> --- a/documentation/test-manual/reproducible-builds.rst
> +++ b/documentation/test-manual/reproducible-builds.rst
> @@ -145,3 +145,21 @@ set of recipes before the test, meaning they are excluded from reproducibility
>   testing. As a practical example, you could set ``sstate_targets`` to
>   ``core-image-sato``, then setting ``targets`` to ``core-image-sato-sdk`` would
>   run reproducibility tests only on the targets belonging only to ``core-image-sato-sdk``.
> +
> +Using `OEQA_REPRODUCIBLE_TEST_*` variables

Sorry, I meant double-tick quoting, the same way we do for the classes 
in documentation/ref-manual/classes.rst, c.f.

``allarch``
===========

My grep-fu didn't return anything with :term: in titles, so I guess 
that's why we're going with double-quotes typically?

Looks good otherwise (see comments on v1 I just sent for the end of the 
diff in v2).

Cheers,
Quentin


^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
  2025-02-06 21:57 [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Yoann Congal
                   ` (2 preceding siblings ...)
  2025-02-07  8:53 ` [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Quentin Schulz
@ 2025-02-07  9:26 ` Antonin Godard
  2025-02-09 23:27   ` Yoann Congal
  3 siblings, 1 reply; 11+ messages in thread
From: Antonin Godard @ 2025-02-07  9:26 UTC (permalink / raw)
  To: yoann.congal, docs; +Cc: Guillaume Swaenepoel

Hi Yoann,

On Thu Feb 6, 2025 at 10:57 PM CET, Yoann Congal via lists.yoctoproject.org wrote:
> From: Yoann Congal <yoann.congal@smile.fr>
>
> This documents the variable used in the "automate testing a single
> recipe's reproducibility" feature [YOCTO #15701]
>
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
> ---
>  documentation/ref-manual/variables.rst | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 47d4e814f..32e91b6db 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5802,6 +5802,11 @@ system and gives an overview of their function and contents.
>        For additional information on how this variable is used, see the
>        initialization script.
>  
> +   :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
> +      Set build target for build reproducibility testing but activate
> +      :ref:`shared state <overview-manual/concepts:shared state cache>` build
> +      for most dependencies. See :doc:`/test-manual/reproducible-builds`.
> +
>     :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE`
>        Set the package manager(s) for build reproducibility testing.
>        See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`

This is nice to see :)

My suggestion on top of Quentin's: you can add this to
documentation/migration-guides/release-notes-5.2.rst's "New variables:" bullet
list.

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables
  2025-02-07  9:13   ` [docs] " Quentin Schulz
@ 2025-02-09 22:59     ` Yoann Congal
  2025-02-10 16:39       ` Quentin Schulz
  0 siblings, 1 reply; 11+ messages in thread
From: Yoann Congal @ 2025-02-09 22:59 UTC (permalink / raw)
  To: Quentin Schulz, docs; +Cc: Guillaume Swaenepoel



Le 07/02/2025 à 10:13, Quentin Schulz a écrit :
> Hi Yoann,
> 
> On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
>> From: Yoann Congal <yoann.congal@smile.fr>
>>
>> Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
>> and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were
>> shown earlier.
>>
>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
>> ---
>> v1->v2: Quentin's review
>> * tick-quote variable in title
>> * a set of recipeS
>> * 3 spaces to align a code block (not 4)
>> ---
>>   .../test-manual/reproducible-builds.rst        | 18 ++++++++++++++++++
>>   1 file changed, 18 insertions(+)
>>
>> diff --git a/documentation/test-manual/reproducible-builds.rst b/
>> documentation/test-manual/reproducible-builds.rst
>> index b9f671d68..77c15d6e2 100644
>> --- a/documentation/test-manual/reproducible-builds.rst
>> +++ b/documentation/test-manual/reproducible-builds.rst
>> @@ -145,3 +145,21 @@ set of recipes before the test, meaning they are
>> excluded from reproducibility
>>   testing. As a practical example, you could set ``sstate_targets`` to
>>   ``core-image-sato``, then setting ``targets`` to ``core-image-sato-
>> sdk`` would
>>   run reproducibility tests only on the targets belonging only to
>> ``core-image-sato-sdk``.
>> +
>> +Using `OEQA_REPRODUCIBLE_TEST_*` variables
> 
> Sorry, I meant double-tick quoting, the same way we do for the classes
> in documentation/ref-manual/classes.rst, c.f.

I'll fix in v3.

> ``allarch``
> ===========
> 
> My grep-fu didn't return anything with :term: in titles, so I guess
> that's why we're going with double-quotes typically?

That does ring a bell:
https://git.yoctoproject.org/yocto-docs/commit/?id=b9e19a00a3aac05a2cdd35b61dfae6d5a1a9c648
...but in this case the linkage works (but the link is rendered as black
wheras the rest of the title is blue, looks a bit weird IMHO).
Also, since I don't point a single variable but the whole
OEQA_REPRODUCIBLE_TEST_* group, I'd rather leave it with double quotes.


> Looks good otherwise (see comments on v1 I just sent for the end of the
> diff in v2).
> 
> Cheers,
> Quentin

Thanks!
-- 
Yoann Congal
Smile ECS - Tech Expert



^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
  2025-02-07  8:53 ` [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Quentin Schulz
@ 2025-02-09 22:59   ` Yoann Congal
  0 siblings, 0 replies; 11+ messages in thread
From: Yoann Congal @ 2025-02-09 22:59 UTC (permalink / raw)
  To: Quentin Schulz, docs; +Cc: Guillaume Swaenepoel



Le 07/02/2025 à 09:53, Quentin Schulz a écrit :
> Hi Yoann,
> 
> On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
>> From: Yoann Congal <yoann.congal@smile.fr>
>>
>> This documents the variable used in the "automate testing a single
>> recipe's reproducibility" feature [YOCTO #15701]
>>
>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
>> ---
>>   documentation/ref-manual/variables.rst | 5 +++++
>>   1 file changed, 5 insertions(+)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/
>> ref-manual/variables.rst
>> index 47d4e814f..32e91b6db 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -5802,6 +5802,11 @@ system and gives an overview of their function
>> and contents.
>>         For additional information on how this variable is used, see the
>>         initialization script.
>>   +   :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
>> +      Set build target for build reproducibility testing but activate
> 
> s/target/target(s)/
> 
> based on the code that uses it in OE-Core and also the name which is in
> plural :)
> 
> Is this correct?

That is correct. Thanks! I'll fix in v3.

> Cheers,
> Quentin

-- 
Yoann Congal
Smile ECS - Tech Expert



^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
  2025-02-07  9:26 ` Antonin Godard
@ 2025-02-09 23:27   ` Yoann Congal
  0 siblings, 0 replies; 11+ messages in thread
From: Yoann Congal @ 2025-02-09 23:27 UTC (permalink / raw)
  To: Antonin Godard, docs; +Cc: Guillaume Swaenepoel



Le 07/02/2025 à 10:26, Antonin Godard a écrit :
> Hi Yoann,
> 
> On Thu Feb 6, 2025 at 10:57 PM CET, Yoann Congal via lists.yoctoproject.org wrote:
>> From: Yoann Congal <yoann.congal@smile.fr>
>>
>> This documents the variable used in the "automate testing a single
>> recipe's reproducibility" feature [YOCTO #15701]
>>
>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
>> ---
>>  documentation/ref-manual/variables.rst | 5 +++++
>>  1 file changed, 5 insertions(+)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index 47d4e814f..32e91b6db 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -5802,6 +5802,11 @@ system and gives an overview of their function and contents.
>>        For additional information on how this variable is used, see the
>>        initialization script.
>>  
>> +   :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
>> +      Set build target for build reproducibility testing but activate
>> +      :ref:`shared state <overview-manual/concepts:shared state cache>` build
>> +      for most dependencies. See :doc:`/test-manual/reproducible-builds`.
>> +
>>     :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE`
>>        Set the package manager(s) for build reproducibility testing.
>>        See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`
> 
> This is nice to see :)
> 
> My suggestion on top of Quentin's: you can add this to
> documentation/migration-guides/release-notes-5.2.rst's "New variables:" bullet
> list.

Added in v3 :)

Thanks!

> Antonin
-- 
Yoann Congal
Smile ECS - Tech Expert



^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables
  2025-02-09 22:59     ` Yoann Congal
@ 2025-02-10 16:39       ` Quentin Schulz
  2025-02-11 23:48         ` Yoann Congal
  0 siblings, 1 reply; 11+ messages in thread
From: Quentin Schulz @ 2025-02-10 16:39 UTC (permalink / raw)
  To: Yoann Congal, docs; +Cc: Guillaume Swaenepoel

Hi Yoann,

On 2/9/25 11:59 PM, Yoann Congal wrote:
> 
> 
> Le 07/02/2025 à 10:13, Quentin Schulz a écrit :
>> Hi Yoann,
>>
>> On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
>>> From: Yoann Congal <yoann.congal@smile.fr>
>>>
>>> Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
>>> and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were
>>> shown earlier.
>>>
>>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>>> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
>>> ---
>>> v1->v2: Quentin's review
>>> * tick-quote variable in title
>>> * a set of recipeS
>>> * 3 spaces to align a code block (not 4)
>>> ---
>>>    .../test-manual/reproducible-builds.rst        | 18 ++++++++++++++++++
>>>    1 file changed, 18 insertions(+)
>>>
>>> diff --git a/documentation/test-manual/reproducible-builds.rst b/
>>> documentation/test-manual/reproducible-builds.rst
>>> index b9f671d68..77c15d6e2 100644
>>> --- a/documentation/test-manual/reproducible-builds.rst
>>> +++ b/documentation/test-manual/reproducible-builds.rst
>>> @@ -145,3 +145,21 @@ set of recipes before the test, meaning they are
>>> excluded from reproducibility
>>>    testing. As a practical example, you could set ``sstate_targets`` to
>>>    ``core-image-sato``, then setting ``targets`` to ``core-image-sato-
>>> sdk`` would
>>>    run reproducibility tests only on the targets belonging only to
>>> ``core-image-sato-sdk``.
>>> +
>>> +Using `OEQA_REPRODUCIBLE_TEST_*` variables
>>
>> Sorry, I meant double-tick quoting, the same way we do for the classes
>> in documentation/ref-manual/classes.rst, c.f.
> 
> I'll fix in v3.
> 
>> ``allarch``
>> ===========
>>
>> My grep-fu didn't return anything with :term: in titles, so I guess
>> that's why we're going with double-quotes typically?
> 
> That does ring a bell:
> https://git.yoctoproject.org/yocto-docs/commit/?id=b9e19a00a3aac05a2cdd35b61dfae6d5a1a9c648
> ...but in this case the linkage works (but the link is rendered as black

Ahah! Thanks for the pointer :)

> wheras the rest of the title is blue, looks a bit weird IMHO).
> Also, since I don't point a single variable but the whole
> OEQA_REPRODUCIBLE_TEST_* group, I'd rather leave it with double quotes.
> 

We actually do have a bunch of those already:

:term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables.
See the :term:`SYSROOT_* <SYSROOT_DESTDIR>` variables
:term:`module_conf_* <module_conf>` variable.

etc.

Cheers,
Quentin


^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [docs] [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables
  2025-02-10 16:39       ` Quentin Schulz
@ 2025-02-11 23:48         ` Yoann Congal
  0 siblings, 0 replies; 11+ messages in thread
From: Yoann Congal @ 2025-02-11 23:48 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: docs, Guillaume Swaenepoel

[-- Attachment #1: Type: text/plain, Size: 2923 bytes --]

Le lun. 10 févr. 2025 à 17:39, Quentin Schulz <quentin.schulz@cherry.de> a
écrit :

> Hi Yoann,
>
> On 2/9/25 11:59 PM, Yoann Congal wrote:
> >
> >
> > Le 07/02/2025 à 10:13, Quentin Schulz a écrit :
> >> Hi Yoann,
> >>
> >> On 2/6/25 10:57 PM, Yoann Congal via lists.yoctoproject.org wrote:
> >>> From: Yoann Congal <yoann.congal@smile.fr>
> >>>
> >>> Shows an example of the new variable
> OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
> >>> and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that
> were
> >>> shown earlier.
> >>>
> >>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> >>> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
> >>> ---
> >>> v1->v2: Quentin's review
> >>> * tick-quote variable in title
> >>> * a set of recipeS
> >>> * 3 spaces to align a code block (not 4)
> >>> ---
> >>>    .../test-manual/reproducible-builds.rst        | 18
> ++++++++++++++++++
> >>>    1 file changed, 18 insertions(+)
> >>>
> >>> diff --git a/documentation/test-manual/reproducible-builds.rst b/
> >>> documentation/test-manual/reproducible-builds.rst
> >>> index b9f671d68..77c15d6e2 100644
> >>> --- a/documentation/test-manual/reproducible-builds.rst
> >>> +++ b/documentation/test-manual/reproducible-builds.rst
> >>> @@ -145,3 +145,21 @@ set of recipes before the test, meaning they are
> >>> excluded from reproducibility
> >>>    testing. As a practical example, you could set ``sstate_targets`` to
> >>>    ``core-image-sato``, then setting ``targets`` to ``core-image-sato-
> >>> sdk`` would
> >>>    run reproducibility tests only on the targets belonging only to
> >>> ``core-image-sato-sdk``.
> >>> +
> >>> +Using `OEQA_REPRODUCIBLE_TEST_*` variables
> >>
> >> Sorry, I meant double-tick quoting, the same way we do for the classes
> >> in documentation/ref-manual/classes.rst, c.f.
> >
> > I'll fix in v3.
> >
> >> ``allarch``
> >> ===========
> >>
> >> My grep-fu didn't return anything with :term: in titles, so I guess
> >> that's why we're going with double-quotes typically?
> >
> > That does ring a bell:
> >
> https://git.yoctoproject.org/yocto-docs/commit/?id=b9e19a00a3aac05a2cdd35b61dfae6d5a1a9c648
> > ...but in this case the linkage works (but the link is rendered as black
>
> Ahah! Thanks for the pointer :)
>
> > wheras the rest of the title is blue, looks a bit weird IMHO).
> > Also, since I don't point a single variable but the whole
> > OEQA_REPRODUCIBLE_TEST_* group, I'd rather leave it with double quotes.
> >
>
> We actually do have a bunch of those already:
>
> :term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables.
> See the :term:`SYSROOT_* <SYSROOT_DESTDIR>` variables
> :term:`module_conf_* <module_conf>` variable.
>
> etc.
>

I've missed this review for v4, I've sent v5 with it.

Thanks!


> Cheers,
> Quentin
>


-- 
Yoann Congal
Smile ECS - Tech expert

[-- Attachment #2: Type: text/html, Size: 4686 bytes --]

^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2025-02-11 23:49 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-02-06 21:57 [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Yoann Congal
2025-02-06 21:57 ` [PATCH v2 2/3] reproducible-builds: change/add titles in the "How" section Yoann Congal
2025-02-06 21:57 ` [PATCH v2 3/3] reproducible-builds: add a "How to" section with OEQA* variables Yoann Congal
2025-02-07  9:13   ` [docs] " Quentin Schulz
2025-02-09 22:59     ` Yoann Congal
2025-02-10 16:39       ` Quentin Schulz
2025-02-11 23:48         ` Yoann Congal
2025-02-07  8:53 ` [docs] [PATCH v2 1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS Quentin Schulz
2025-02-09 22:59   ` Yoann Congal
2025-02-07  9:26 ` Antonin Godard
2025-02-09 23:27   ` Yoann Congal

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.