diff mbox series

[v2,08/12] ref-manual/variables.rst: document autotools class related variables

Message ID 20250325-release-note-5-2-updates-v2-8-19f050d61da3@bootlin.com
State Under Review
Headers show
Series Updates for upcoming 5.2 release | expand

Commit Message

Antonin Godard March 25, 2025, 9:20 a.m. UTC
Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Quentin Schulz March 28, 2025, 2:12 p.m. UTC | #1
Hi Antonin,

On 3/25/25 10:20 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 17 +++++++++++++++++
>   1 file changed, 17 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 597b0d031..e9e8a6933 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -224,6 +224,12 @@ system and gives an overview of their function and contents.
>         must set this variable in your recipe. The
>         :ref:`ref-classes-syslinux` class checks this variable.
>   
> +   :term:`AUTOTOOLS_SCRIPT_PATH`
> +      When using the :ref:`ref-classes-autotools` class, the
> +      :term:`AUTOTOOLS_SCRIPT_PATH` variable stores the location of the
> +      different scripts used by the Autotools build system. The default
> +      value for this variable is :term:`S`.
> +
>      :term:`AVAILTUNES`
>         The list of defined CPU and Application Binary Interface (ABI)
>         tunings (i.e. "tunes") available for use by the OpenEmbedded build
> @@ -1528,6 +1534,17 @@ system and gives an overview of their function and contents.
>      :term:`CONFIGURE_FLAGS`
>         The minimal arguments for GNU configure.
>   
> +   :term:`CONFIGURE_SCRIPT`
> +      When using the :ref:`ref-classes-autotools` class, the
> +      :term:`CONFIGURE_SCRIPT` variable stores the location of the ``configure``
> +      script for the Autotools build system. The default definition for this
> +      variable is::
> +
> +         CONFIGURE_SCRIPT ?= "${AUTOTOOLS_SCRIPT_PATH}/configure"
> +
> +      Where :term:`AUTOTOOLS_SCRIPT_PATH` is the location of the of the
> +      Autotools build system scripts, which defaults to :term:`S`.
> +

I would avoid having multiple locations for the default of a given 
variable, makes it easier to avoid forgetting to update all the locations.

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

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 597b0d031..e9e8a6933 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -224,6 +224,12 @@  system and gives an overview of their function and contents.
       must set this variable in your recipe. The
       :ref:`ref-classes-syslinux` class checks this variable.
 
+   :term:`AUTOTOOLS_SCRIPT_PATH`
+      When using the :ref:`ref-classes-autotools` class, the
+      :term:`AUTOTOOLS_SCRIPT_PATH` variable stores the location of the
+      different scripts used by the Autotools build system. The default
+      value for this variable is :term:`S`.
+
    :term:`AVAILTUNES`
       The list of defined CPU and Application Binary Interface (ABI)
       tunings (i.e. "tunes") available for use by the OpenEmbedded build
@@ -1528,6 +1534,17 @@  system and gives an overview of their function and contents.
    :term:`CONFIGURE_FLAGS`
       The minimal arguments for GNU configure.
 
+   :term:`CONFIGURE_SCRIPT`
+      When using the :ref:`ref-classes-autotools` class, the
+      :term:`CONFIGURE_SCRIPT` variable stores the location of the ``configure``
+      script for the Autotools build system. The default definition for this
+      variable is::
+
+         CONFIGURE_SCRIPT ?= "${AUTOTOOLS_SCRIPT_PATH}/configure"
+
+      Where :term:`AUTOTOOLS_SCRIPT_PATH` is the location of the of the
+      Autotools build system scripts, which defaults to :term:`S`.
+
    :term:`CONFLICT_DISTRO_FEATURES`
       When inheriting the :ref:`ref-classes-features_check`
       class, this variable identifies distribution features that would be