ref-manual/variables: document the CARGO_INSTALL_LIBRARIES variable

This variable controls whether libraries compiled by recipes inheriting
cargo are installed or not.

(From yocto-docs rev: c42f80a12e9e71fa7dab9672fb3174ed006b214b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 9 insertions, 0 deletions

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 2a97ff98d3..1d4e2e2be6 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1230,6 +1230,15 @@ 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 the installation of the libraries the
+      recipe has built in ``${B}/target/${CARGO_TARGET_SUBDIR}`` (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.