diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index cbb119bd7b..0fa4313813 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -2856,6 +2856,13 @@ which can also be set in your ``local.conf`` file. Here is an example:: RM_WORK_EXCLUDE += "busybox glibc" +Finally, if you are using this class for a recipe but want to prevent +:term:`BitBake` from deleting specific folders or files in that recipe's +:term:`WORKDIR` (other than ``temp``), you can preserve those folders or +files with the :term:`RM_WORK_EXCLUDE_ITEMS` variable as follows:: + + RM_WORK_EXCLUDE_ITEMS += "items_to_keep" + .. _ref-classes-rootfs*: ``rootfs*`` diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c0f986bbc8..66bd13a7b6 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7533,6 +7533,12 @@ system and gives an overview of their function and contents. specifies a list of recipes whose work directories should not be removed. See the ":ref:`ref-classes-rm-work`" section for more details. + :term:`RM_WORK_EXCLUDE_ITEMS` + With :ref:`ref-classes-rm-work` enabled, this variable specifies + a list of files or folders --- relative to the recipe's :term:`WORKDIR` --- + to be preserved. + See the ":ref:`ref-classes-rm-work`" section for more details. + :term:`ROOT_HOME` Defines the root home directory. By default, this directory is set as follows in the BitBake configuration file::