| Message ID | 20241016140940.3166992-1-niko.mauno@vaisala.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | [PATCHv5,1/2] docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES | expand |
Hi Niko, On 10/16/24 4:09 PM, Niko Mauno wrote: > 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 | 40 +++++++++---------- > 3 files changed, 27 insertions(+), 24 deletions(-) > > diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst > index 298ff3e250..2b945f8165 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, :term:`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 :term:`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..6e52dfce17 100644 > --- a/documentation/ref-manual/features.rst > +++ b/documentation/ref-manual/features.rst > @@ -327,8 +327,9 @@ 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 the > + ``files/fs-perms-volatile-log.txt`` value 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 32c9e7407d..c27a0ad7d6 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,30 @@ 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 your distribution configuration file 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. > > - For guidance on how to create your own file permissions settings > - table file, examine the existing ``fs-perms.txt``. > + 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``. missing :term: here, but maybe Antonin could fix this when applying :) Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> @Antonin, candidate for styhead backport I believe (I see a styhead branch but I don't know if you've branched off already, so mentioning anyway). Thanks! Quentin
diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst index 298ff3e250..2b945f8165 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, :term:`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 :term:`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..6e52dfce17 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst @@ -327,8 +327,9 @@ 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 the + ``files/fs-perms-volatile-log.txt`` value 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 32c9e7407d..c27a0ad7d6 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,30 @@ 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 your distribution configuration file 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. - For guidance on how to create your own file permissions settings - table file, examine the existing ``fs-perms.txt``. + 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 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 +9987,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.
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 | 40 +++++++++---------- 3 files changed, 27 insertions(+), 24 deletions(-)