diff mbox series

[v2] ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPS

Message ID 20250519100534.44168-1-alperyasinak1@gmail.com
State New
Headers show
Series [v2] ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPS | expand

Commit Message

Alper Ak May 19, 2025, 10:05 a.m. UTC
Fix [YOCTO #15756]

Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Quentin Schulz May 19, 2025, 11:06 a.m. UTC | #1
Hi Alper,

On 5/19/25 12:05 PM, Alper Ak via lists.yoctoproject.org wrote:
> [You don't often get email from alperyasinak1=gmail.com@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> Fix [YOCTO #15756]
> 
> Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
> ---
>   documentation/ref-manual/variables.rst | 14 ++++++++++++++
>   1 file changed, 14 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 643a3e7ae..1a3c52045 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4487,6 +4487,20 @@ system and gives an overview of their function and contents.
> 
>            INHERIT_DISTRO ?= "debian devshell sstate license remove-libtool create-spdx"
> 
> +   :term:`INHIBIT_AUTOTOOLS_DEPS`
> +      Prevents the :ref:`ref-classes-autotools` class from automatically adding its default build-time dependencies.
> +
> +      When a recipe inherits the :ref:`ref-classes-autotools` class, several native cross tools such as
> +      ``autoconf-native``, ``automake-native``, ``libtool-native``, ``libtool-cross``
> +      are added to :term:`DEPENDS` to support the autotools build process.

``autotools``
here maybe?

> +
> +      To prevent the build system from adding these dependencies automatically, set the
> +      :term:`INHIBIT_AUTOTOOLS_DEPS` variable as follows::
> +
> +         INHIBIT_AUTOTOOLS_DEPS = "1"
> +
> +      By default, the value of :term:`INHIBIT_AUTOTOOLS_DEPS` is empty.
> +

Please specify that to NOT inhibit, you need to set it to the empty 
string (I believe, considering the first line in get_autotools_dep() in 
meta/classes-recipe/autotools.bbclass). Setting it to 0 is not going to 
disable the inhibition.

Looks good to me otherwise!

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 643a3e7ae..1a3c52045 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4487,6 +4487,20 @@  system and gives an overview of their function and contents.
 
          INHERIT_DISTRO ?= "debian devshell sstate license remove-libtool create-spdx"
 
+   :term:`INHIBIT_AUTOTOOLS_DEPS`
+      Prevents the :ref:`ref-classes-autotools` class from automatically adding its default build-time dependencies.
+
+      When a recipe inherits the :ref:`ref-classes-autotools` class, several native cross tools such as
+      ``autoconf-native``, ``automake-native``, ``libtool-native``, ``libtool-cross``
+      are added to :term:`DEPENDS` to support the autotools build process.
+
+      To prevent the build system from adding these dependencies automatically, set the
+      :term:`INHIBIT_AUTOTOOLS_DEPS` variable as follows::
+
+         INHIBIT_AUTOTOOLS_DEPS = "1"
+
+      By default, the value of :term:`INHIBIT_AUTOTOOLS_DEPS` is empty.
+
    :term:`INHIBIT_DEFAULT_DEPS`
       Prevents the default dependencies, namely the C compiler and standard
       C library (libc), from being added to :term:`DEPENDS`.