diff mbox series

[v6,3/4] reproducible-builds: add a "How to" section with OEQA* variables

Message ID 20250217220618.1999362-3-yoann.congal@smile.fr
State Under Review
Headers show
Series [v6,1/4] ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS | expand

Commit Message

Yoann Congal Feb. 17, 2025, 10:06 p.m. UTC 
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>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
---
v5->v6:
Quentin's review
* Proper highliting (:term:, :ref: and ``)
* s/varflags/varflag/
* Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (Thanks!)

v4->v5: Quentin's review:
* use :term: link in title

v3->v4:
Quentin's Review
* make missing dependencies more explicit
Guillaume's Reviewed-by

v2->v3: Quentin's review
* Double tick quote variable in title
* Removed Guillaume Reviewed-by (given privately)

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       | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)
diff mbox series

Patch

diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
index b9f671d68..8559cbcf0 100644
--- a/documentation/test-manual/reproducible-builds.rst
+++ b/documentation/test-manual/reproducible-builds.rst
@@ -145,3 +145,24 @@  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 :term:`OEQA_REPRODUCIBLE_TEST_* <OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS>` 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 of its
+dependencies (i.e. the ones explicitly listed in :term:`DEPENDS`, which may not
+be all dependencies, c.f. :ref:`[depends] varflag
+<bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`,
+``PACKAGE_DEPENDS`` and other implementations).
+
+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>`.