diff mbox series

[v1,2/2] ref-manual/variables: add new variables for v5.0

Message ID 20240410091124.2976089-3-joaomarcos.costa@bootlin.com
State New
Headers show
Series Add updates to release-notes-5.0 | expand

Commit Message

Joao Marcos Costa April 10, 2024, 9:11 a.m. UTC
From: Joao Marcos Costa <joaomarcos.costa@bootlin.com>

Add variables newly referenced in release-notes-5.0.

Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
---
 documentation/ref-manual/variables.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

Michael Opdenacker April 10, 2024, 9:35 a.m. UTC | #1
Hi João,

Thanks for this update!
I'm actually taking this one first, as your first patch depends on this 
one (otherwise there will be compiling failures... we also want the docs 
to be bisectable!)

On 4/10/24 at 11:11, joaomarcos.costa@bootlin.com wrote:
> From: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
>
> Add variables newly referenced in release-notes-5.0.
>
> Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 16 ++++++++++++++++
>   1 file changed, 16 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 97abb398c..d4cb0e6e3 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -561,6 +561,10 @@ system and gives an overview of their function and contents.
>      :term:`BB_INVALIDCONF`
>         See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual.
>   
> +   :term:`BB_LOADFACTOR_MAX`
> +      The system load threshold above which BitBake will stop runnig extra
> +      tasks.
> +
>      :term:`BB_LOGCONFIG`
>         See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual.
>   
> @@ -2335,6 +2339,12 @@ system and gives an overview of their function and contents.
>         See the :ref:`ref-classes-systemd-boot` and :ref:`ref-classes-image-live`
>         classes for more information.
>   
> +   :term:`EFI_UKI_DIR`
> +      The primary place for the UKI image inside the EFI System Partition.
> +
> +   :term:`EFI_UKI_PATH`
> +      The path for the UKI image inside the rootfs.


I'm replacing "rootfs" with "root filesystem". It's true that's every 
day jargon, but the original words sound better in documentation.

> +
>      :term:`ENABLE_BINARY_LOCALE_GENERATION`
>         Variable that controls which locales for ``glibc`` are generated
>         during the build (useful if the target device has 64Mbytes of RAM or
> @@ -5671,6 +5681,9 @@ system and gives an overview of their function and contents.
>         default by setting the variable in a custom distribution
>         configuration file.
>   
> +   :term:`OPKG_MAKE_INDEX_EXTRA_PARAMS`
> +      Specifies extra parameters for opkg-make-index command.

s/opkg-make-index/the ``opkg-make-index``/
Fixed.

> +
>      :term:`OVERLAYFS_ETC_DEVICE`
>         When the :ref:`ref-classes-overlayfs-etc` class is
>         inherited, specifies the device to be mounted for the read/write
> @@ -7152,6 +7165,9 @@ system and gives an overview of their function and contents.
>         :term:`IMAGE_ROOTFS` variable for more
>         information.
>   
> +   :term:`RPMBUILD_EXTRA_PARAMS`
> +      Specifies extra user-defined parameters for rpmbuild command.


Same here. Fixed. We're more talking about the command name than the 
name of the tool.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 97abb398c..d4cb0e6e3 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -561,6 +561,10 @@  system and gives an overview of their function and contents.
    :term:`BB_INVALIDCONF`
       See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual.
 
+   :term:`BB_LOADFACTOR_MAX`
+      The system load threshold above which BitBake will stop runnig extra
+      tasks.
+
    :term:`BB_LOGCONFIG`
       See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual.
 
@@ -2335,6 +2339,12 @@  system and gives an overview of their function and contents.
       See the :ref:`ref-classes-systemd-boot` and :ref:`ref-classes-image-live`
       classes for more information.
 
+   :term:`EFI_UKI_DIR`
+      The primary place for the UKI image inside the EFI System Partition.
+
+   :term:`EFI_UKI_PATH`
+      The path for the UKI image inside the rootfs.
+
    :term:`ENABLE_BINARY_LOCALE_GENERATION`
       Variable that controls which locales for ``glibc`` are generated
       during the build (useful if the target device has 64Mbytes of RAM or
@@ -5671,6 +5681,9 @@  system and gives an overview of their function and contents.
       default by setting the variable in a custom distribution
       configuration file.
 
+   :term:`OPKG_MAKE_INDEX_EXTRA_PARAMS`
+      Specifies extra parameters for opkg-make-index command.
+
    :term:`OVERLAYFS_ETC_DEVICE`
       When the :ref:`ref-classes-overlayfs-etc` class is
       inherited, specifies the device to be mounted for the read/write
@@ -7152,6 +7165,9 @@  system and gives an overview of their function and contents.
       :term:`IMAGE_ROOTFS` variable for more
       information.
 
+   :term:`RPMBUILD_EXTRA_PARAMS`
+      Specifies extra user-defined parameters for rpmbuild command.
+
    :term:`RPROVIDES`
       A list of package name aliases that a package also provides. These
       aliases are useful for satisfying runtime dependencies of other