[v2,1/3] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS

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(+)

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

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

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

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