diff mbox series

[PATCHv5,2/2] docs: Replace VOLATILE_TMP_DIR with FILESYSTEM_PERMS_TABLES

Message ID 20241016140940.3166992-2-niko.mauno@vaisala.com
State Under Review
Headers show
Series [PATCHv5,1/2] docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES | expand

Commit Message

Niko Mauno Oct. 16, 2024, 2:09 p.m. UTC 
The VOLATILE_TMP_DIR variable was removed and it's functionality
replaced with a FILESYSTEM_PERMS_TABLES entry in
https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1
("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead")

Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
---
 .../migration-guides/migration-5.1.rst        |  6 ++++
 .../migration-guides/release-notes-4.2.rst    |  2 +-
 documentation/ref-manual/variables.rst        | 28 ++++++-------------
 3 files changed, 16 insertions(+), 20 deletions(-)

Comments

Quentin Schulz Oct. 16, 2024, 2:14 p.m. UTC | #1 
Hi Niko,

On 10/16/24 4:09 PM, Niko Mauno wrote:
> The VOLATILE_TMP_DIR variable was removed and it's functionality
> replaced with a FILESYSTEM_PERMS_TABLES entry in
> https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1
> ("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead")
> 
> Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!

@Antonin, candidate for styhead backport I believe.

Quentin
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index 2b945f8165..7d6c976cd8 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -123,6 +123,12 @@  The following variables have been removed:
    enabled. Users can disable the volatile log by removing the value
    ``files/fs-perms-volatile-log.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
 
+-  ``VOLATILE_TMP_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead.
+   By default, :term:`FILESYSTEM_PERMS_TABLES` now contains the value
+   ``files/fs-perms-volatile-tmp.txt``, which means that volatile tmp is
+   enabled. Users can disable the volatile tmp by removing the value
+   ``files/fs-perms-volatile-tmp.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
+
 .. _migration-5.1-removed-recipes:
 
 Removed recipes
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst
index 30049b89f6..ee81d8367a 100644
--- a/documentation/migration-guides/release-notes-4.2.rst
+++ b/documentation/migration-guides/release-notes-4.2.rst
@@ -38,7 +38,7 @@  New Features / Enhancements in 4.2
 
 -  New variables:
 
-   -  :term:`VOLATILE_TMP_DIR` allows to specify
+   -  ``VOLATILE_TMP_DIR`` allows to specify
       whether ``/tmp`` should be on persistent storage
       or in RAM.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c27a0ad7d6..f66c1bb497 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2994,10 +2994,11 @@  system and gives an overview of their function and contents.
       and users across an entire work project. It is best to do this in the
       packages themselves but this is not always possible.
 
-      By default, the OpenEmbedded build system uses the ``fs-perms.txt`` and
-      ``fs-perms-volatile-log.txt`` which are located in the ``meta/files``
-      folder in the :term:`Source Directory`. If you create your own permission
-      setting table files, you should place those in your layer.
+      By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
+      ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` which are
+      located in the ``meta/files`` folder in the :term:`Source Directory`. If
+      you create your own permission setting table files, you should place
+      those in your layer.
 
       You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable
       in your distribution configuration file to point to your custom
@@ -3007,11 +3008,12 @@  system and gives an overview of their function and contents.
 
       In order to disable the volatile log, which is enabled by default, one
       can remove the ``files/fs-perms-volatile-log.txt`` value from
-      ``FILESYSTEM_PERMS_TABLES``.
+      ``FILESYSTEM_PERMS_TABLES``. Similarly, in order to disable the volatile
+      tmp, one can remove the ``files/fs-perms-volatile-tmp.txt`` value.
 
       For guidance on how to define your own file permissions settings
-      tables, examine the existing ``fs-perms.txt`` and
-      ``fs-perms-volatile-log.txt`` files.
+      tables, examine the existing ``fs-perms.txt``,
+      ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` files.
 
    :term:`FIT_ADDRESS_CELLS`
       Specifies the value of the ``#address-cells`` value for the
@@ -9987,18 +9989,6 @@  system and gives an overview of their function and contents.
 
          PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
 
-   :term:`VOLATILE_TMP_DIR`
-      Specifies the persistence of the target's ``/tmp`` directory.
-
-      By default, :term:`VOLATILE_TMP_DIR` is set to "yes", in which case
-      ``/tmp`` links to a directory which resides in RAM in a ``tmpfs``
-      filesystem.
-
-      If instead, you want the ``/tmp`` directory to be persistent, set the
-      variable to "no" to make it a regular directory in the root filesystem.
-
-      This supports both sysvinit and systemd based systems.
-
    :term:`WARN_QA`
       Specifies the quality assurance checks whose failures are reported as
       warnings by the OpenEmbedded build system. You set this variable in