diff mbox series

[PATCHv3,1/2] docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES

Message ID 20241016092340.262802-1-niko.mauno@vaisala.com
State New
Headers show
Series [PATCHv3,1/2] docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES | expand

Commit Message

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

Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
---
 .../migration-guides/migration-5.1.rst        |  6 +++
 documentation/ref-manual/features.rst         |  5 ---
 documentation/ref-manual/variables.rst        | 41 +++++++++----------
 3 files changed, 25 insertions(+), 27 deletions(-)

Comments

Antonin Godard Oct. 16, 2024, 11:24 a.m. UTC | #1 
Hi Niko,

Thanks for this new version.
I think we're almost set, just see my comment below.

On Wed Oct 16, 2024 at 11:23 AM CEST, Niko Mauno via lists.yoctoproject.org wrote:
> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
> index b2ba731bb2..84ebfa81ae 100644
> --- a/documentation/ref-manual/features.rst
> +++ b/documentation/ref-manual/features.rst
> @@ -325,11 +325,6 @@ The image features available for all images are:
>     the ``/var/log/postinstall.log`` file on first boot of the image on
>     the target system.
>
> -   .. note::
> -
> -      To make the ``/var/log`` directory on the target persistent, use the
> -      :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
> -

As Quentin was saying, it would be nice to avoid removing information here, and
replace it with the new implementation. I'm fine with keeping an explanation in
both the glossary and here, so you can probably paraphrase what you wrote in the
glossary.

Thanks again,
Antonin
Niko Mauno Oct. 16, 2024, 11:59 a.m. UTC | #2 
Thanks - submitted v4, which restores the note followingly:

     .. 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 the
+      ``files/fs-perms-volatile-log.txt`` value from
+      :term:`FILESYSTEM_PERMS_TABLES`.

-Niko

On 16.10.2024 14.24, Antonin Godard wrote:
> [You don't often get email from antonin.godard@bootlin.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> Hi Niko,
> 
> Thanks for this new version.
> I think we're almost set, just see my comment below.
> 
> On Wed Oct 16, 2024 at 11:23 AM CEST, Niko Mauno via lists.yoctoproject.org wrote:
>> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
>> index b2ba731bb2..84ebfa81ae 100644
>> --- a/documentation/ref-manual/features.rst
>> +++ b/documentation/ref-manual/features.rst
>> @@ -325,11 +325,6 @@ The image features available for all images are:
>>      the ``/var/log/postinstall.log`` file on first boot of the image on
>>      the target system.
>>
>> -   .. note::
>> -
>> -      To make the ``/var/log`` directory on the target persistent, use the
>> -      :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
>> -
> 
> As Quentin was saying, it would be nice to avoid removing information here, and
> replace it with the new implementation. I'm fine with keeping an explanation in
> both the glossary and here, so you can probably paraphrase what you wrote in the
> glossary.
> 
> Thanks again,
> Antonin
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index 298ff3e250..f58de3156d 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -117,6 +117,12 @@  Removed variables
 
 The following variables have been removed:
 
+-  ``VOLATILE_LOG_DIR``: :term:`FILESYSTEM_PERMS_TABLES` is now used instead.
+   By default, ``FILESYSTEM_PERMS_TABLES`` now contains the value
+   ``files/fs-perms-volatile-log.txt``, which means that volatile log is
+   enabled. Users can disable the volatile log by removing the value
+   ``files/fs-perms-volatile-log.txt`` from ``FILESYSTEM_PERMS_TABLES``.
+
 .. _migration-5.1-removed-recipes:
 
 Removed recipes
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index b2ba731bb2..84ebfa81ae 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -325,11 +325,6 @@  The image features available for all images are:
    the ``/var/log/postinstall.log`` file on first boot of the image on
    the target system.
 
-   .. note::
-
-      To make the ``/var/log`` directory on the target persistent, use the
-      :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
-
 -  *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
 
 -  *read-only-rootfs:* Creates an image whose root filesystem is
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 32c9e7407d..37007aa202 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -13,7 +13,7 @@  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:`U <UBOOT_CONFIG>` :term:`V <VIRTUAL-RUNTIME>`
 :term:`W <WARN_QA>` :term:`X <XSERVER>`
 
 .. glossary::
@@ -2988,26 +2988,31 @@  system and gives an overview of their function and contents.
       :ref:`ref-tasks-patch` task as well.
 
    :term:`FILESYSTEM_PERMS_TABLES`
-      Allows you to define your own file permissions settings table as part
+      Allows you to define your own file permissions settings tables as part
       of your configuration for the packaging process. For example, suppose
       you need a consistent set of custom permissions for a set of groups
       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 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.
 
-      You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
-      ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
-      to point to your custom ``fs-perms.txt``. You can specify more than a
-      single file permissions setting table. The paths you specify to these
-      files must be defined within the :term:`BBPATH` variable.
+      You can override the value of :term:`FILESYSTEM_PERMS_TABLES` variable
+      in the ``conf/local.conf`` file, which is found in the
+      :term:`Build Directory`, to point to your custom permission table files.
+      You can specify one or more file permissions setting tables. The paths
+      that you specify to these files must be defined within the :term:`BBPATH`
+      variable.
+
+      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``.
 
-      For guidance on how to create your own file permissions settings
-      table file, examine the existing ``fs-perms.txt``.
+      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.
 
    :term:`FIT_ADDRESS_CELLS`
       Specifies the value of the ``#address-cells`` value for the
@@ -9983,14 +9988,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.