diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index e555a80b5..950231f40 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -266,12 +266,15 @@ manager, allowing to fetch package dependencies and build your program. Using this class makes it very easy to build Rust programs. All you need is to use the :term:`SRC_URI` variable to point to a source repository which can be built by Cargo, typically one that was created by the -``cargo new`` command, containing a ``Cargo.toml`` file and a ``src`` +``cargo new`` command, containing a ``Cargo.toml`` file, a ``Cargo.lock`` file and a ``src`` subdirectory. -You will find a simple example in the -:oe_git:`rust-hello-world_git.bb ` -recipe. A more complex example, with package dependencies, is the +If you want to build and package tests of the program, replace :ref:`ref-classes-cargo` +inheritance by :ref:`ref-classes-ptest-cargo` one. + +You will find an example (that show also how to handle possible git source dependencies) in the +:oe_git:`zvariant_3.12.0.bb ` +recipe. Another example, with only crates dependencies, is the :oe_git:`uutils-coreutils ` recipe, which was generated by the `cargo-bitbake `__ tool. @@ -290,6 +293,15 @@ An exception is the "rust" recipe, to build the Rust compiler and runtime library, which is built by Cargo but cannot use the :ref:`ref-classes-cargo` class. This is why this class was introduced. +.. _ref-classes-ptest-cargo: + +``ptest_cargo`` +=============== + +The :ref:`ref-classes-ptest-cargo` class is a class which extend :ref:`ref-classes-cargo` +and add a compile_ptest_cargo/install_ptest_cargo steps to respectively build and install +test suites defined in ``Cargo.toml`` file in a dedicate -ptest package. + .. _ref-classes-ccache: .. _ref-classes-cargo-update-recipe-crates: