public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH] docs: update VOLATILE_{LOG|TMP}_DIR
Date: Wed,  4 Sep 2024 13:27:48 -0400	[thread overview]
Message-ID: <20240904172748.18526-1-twoerner@gmail.com> (raw)

A new mechanism was introduced to handle whether or not tmp and log are
tmpfs-based (i.e. in RAM) or persist as real directories in the root
filesystem. The variables VOLATILE_LOG_DIR and VOLATILE_TMP_DIR no longer
exist, and PERMS files are used instead.

oe-core: 8d1ae67b89c4 ("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead")
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 .../migration-guides/release-notes-5.0.rst    |  2 ++
 documentation/ref-manual/features.rst         |  4 +--
 documentation/ref-manual/variables.rst        | 32 ++++---------------
 3 files changed, 10 insertions(+), 28 deletions(-)

diff --git a/documentation/migration-guides/release-notes-5.0.rst b/documentation/migration-guides/release-notes-5.0.rst
index 800ba20a27b5..191debd0174a 100644
--- a/documentation/migration-guides/release-notes-5.0.rst
+++ b/documentation/migration-guides/release-notes-5.0.rst
@@ -335,6 +335,8 @@ New Features / Enhancements in 5.0
    -  Add minimal VS Code configuration to avoid VS Code's indexer from choking
       on build directories.
 
+   - VOLATILE_LOG_DIR and VOLATILE_TMP_DIR were removed in favour of the
+     FILESYSTEM_PERMS_TABLES mechanism.
 
 Known Issues in 5.0
 ~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 2ea946b31d36..97c05cc2839f 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -323,8 +323,8 @@ The image features available for all images are:
 
    .. note::
 
-      To make the ``/var/log`` directory on the target persistent, use the
-      :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
+      To make the ``/var/log`` directory on the target persistent, remove
+     ``files/fs-perms-volatile-log.txt`` from :term:`FILESYSTEM_PERMS_TABLES`.
 
 -  *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 32c9e7407dbc..994ee23e2709 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -13,7 +13,6 @@ system and gives an overview of their function and contents.
 :term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
 :term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
 :term:`R <RANLIB>` :term:`S` :term:`T`
-:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
 :term:`W <WARN_QA>` :term:`X <XSERVER>`
 
 .. glossary::
@@ -2994,11 +2993,12 @@ 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``,
-      which is located in the ``meta/files`` folder in the :term:`Source Directory`.
-      If you create your own file
-      permissions setting table, you should place it in your layer or the
-      distro's layer.
+      By default, the OpenEmbedded build system uses
+      ``fs-perms.txt``, ``fs-perms-volatile-log.txt``, and
+      ``files/fs-perms-volatile-tmp.txt`` which are located in the
+      ``meta/files`` folder in the :term:`Source Directory`. If you create
+      your own file permissions setting table, you should place it in your
+      layer or the distro's layer.
 
       You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
       ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
@@ -9983,26 +9983,6 @@ system and gives an overview of their function and contents.
 
          PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
 
-   :term:`VOLATILE_LOG_DIR`
-      Specifies the persistence of the target's ``/var/log`` directory,
-      which is used to house postinstall target log files.
-
-      By default, :term:`VOLATILE_LOG_DIR` is set to "yes", which means the
-      file is not persistent. You can override this setting by setting the
-      variable to "no" to make the log directory persistent.
-
-   :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
-- 
2.44.0.501.g19981daefd7c



             reply	other threads:[~2024-09-04 17:28 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-04 17:27 Trevor Woerner [this message]
2024-09-04 19:14 ` [docs] [PATCH] docs: update VOLATILE_{LOG|TMP}_DIR Jörg Sommer
2024-09-09  9:56 ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240904172748.18526-1-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox