doc: modules: document out-of-tree samples/tests

Document how to configure out-of-tree tests/samples and boards in the
module.yml file to be used by sanitycheck.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-12-14 15:36:32 -05:00 committed by Carles Cufí
commit c7ef4f0506

View file

@ -82,6 +82,26 @@ Each project in the ``west list`` output is tested like this:
cmake: .
kconfig: Kconfig
- To execute both tests and samples available in modules, the Zephyr test runner
(sanitycheck) should be pointed to the directories containing those samples and
tests. This can be done by specifying the path to both samples and tests in the
:file:`zephyr/module.yml` file. Additionally, if a module defines out of tree
boards, the module file can point sanitycheck to the path where those files
are maintained in the module. For example:
.. code-block:: yaml
build:
cmake: .
samples:
- samples
tests:
- tests
boards:
- boards
- Otherwise (i.e. if the project has no :file:`zephyr/module.yml`), the
build system looks for :file:`zephyr/CMakeLists.txt` and
:file:`zephyr/Kconfig` files in the project. If both are present, the project