diff mbox series

ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPS

Message ID 20250518145057.85245-1-alperyasinak1@gmail.com
State Superseded
Headers show
Series ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPS | expand

Commit Message

Alper Ak May 18, 2025, 2:50 p.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

Antonin Godard May 19, 2025, 8:46 a.m. UTC | #1
Hi,

On Sun May 18, 2025 at 4:50 PM CEST, Alper Ak via lists.yoctoproject.org wrote:
> 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..d73b0d30e 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 ``autotools``, several native, cross tools such as

s/the ``autotools``/the :ref:`ref-classes-autotools` class/

You can remove the comma after "several native".

> +      ``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`.

Looks good otherwise, thank you.

Antonin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 643a3e7ae..d73b0d30e 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 ``autotools``, 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`.