diff mbox series

[yocto-docs,12/14] ref-manual/variables: document the CARGO_INSTALL_LIBRARIES variable

Message ID 20241217-release-note-5-2-updates-v1-12-b189493b1b09@bootlin.com
State New
Headers show
Series Updates from recent core changes | expand

Commit Message

Antonin Godard Dec. 17, 2024, 9:27 a.m. UTC
This variable controls whether libraries compiled by recipes inheriting
cargo are installed or not.

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

Comments

Quentin Schulz Dec. 17, 2024, 2:32 p.m. UTC | #1
Hi Antonin,

On 12/17/24 10:27 AM, Antonin Godard via lists.yoctoproject.org wrote:
> This variable controls whether libraries compiled by recipes inheriting
> cargo are installed or not.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 66ecece8b2658b304e17c9c4a1492e42a8a313d4..50cd8948b35f381414837acc9b9e925dc5110779 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1231,6 +1231,14 @@ system and gives an overview of their function and contents.
>         :term:`Metadata` so it does not need to be parsed every time
>         BitBake is started.
>   
> +   :term:`CARGO_INSTALL_LIBRARIES`
> +      When inheriting the :ref:`ref-classes-cargo` class, the variable
> +      :term:`CARGO_INSTALL_LIBRARIES` can be set to a non-empty value by
> +      individual recipes to enable or disable installation of the libraries the

If I understood correctly the code, any non-empty value will enable the 
installation, so I suggest to remove "or disable" here.

> +      recipe has built in ``${B}/target`` (files ending with ``.so`` or

actually in ${B}/target/${CARGO_TARGET_SUBDIR} according to the code?

> +      ``.rlib``). By default this variable is not defined and libraries are not
> +      installed, to replicate the behavior of the ``cargo install`` command.
> +

Otherwise, looks good to me.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 66ecece8b2658b304e17c9c4a1492e42a8a313d4..50cd8948b35f381414837acc9b9e925dc5110779 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1231,6 +1231,14 @@  system and gives an overview of their function and contents.
       :term:`Metadata` so it does not need to be parsed every time
       BitBake is started.
 
+   :term:`CARGO_INSTALL_LIBRARIES`
+      When inheriting the :ref:`ref-classes-cargo` class, the variable
+      :term:`CARGO_INSTALL_LIBRARIES` can be set to a non-empty value by
+      individual recipes to enable or disable installation of the libraries the
+      recipe has built in ``${B}/target`` (files ending with ``.so`` or
+      ``.rlib``). By default this variable is not defined and libraries are not
+      installed, to replicate the behavior of the ``cargo install`` command.
+
    :term:`CC`
       The minimal command and arguments used to run the C compiler.