mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-04 13:39:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: add new retain class and variables

Browse Source 
Document the new `retain` class with its configuration variables in the
variable index.

(From yocto-docs rev: b62f1be5dada0fb760ff7e0806b16225f7261560)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2024-10-09 09:41:01 +02:00
committed by Richard Purdie
parent 7b717c7e2a
commit 37ebf54d1c
2 changed files with 52 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/ref-manual/classes.rst
View File

@@ -2728,6 +2728,23 @@ commit, and log. From the information, report files using a JSON format
are created and stored in
``${``\ :term:`LOG_DIR`\ ``}/error-report``.
.. _ref-classes-retain:
``retain``
==========
The :ref:`ref-classes-retain` class can be used to create a tarball of the work
directory for a recipe when one of its tasks fails, or any other nominated
directories. It is useful in cases where the environment in which builds are run
is ephemeral or otherwise inaccessible for examination during debugging.
To enable, add the following to your configuration::
INHERIT += "retain"
The class can be disabled for specific recipes using the :term:`RETAIN_ENABLED`
variable.
.. _ref-classes-rm-work:
``rm_work``