diff mbox series

[v2] contributor-guide: Add notes for tests

Message ID 20240305164651.5132-1-simone.p.weiss@posteo.com
State New
Headers show
Series [v2] contributor-guide: Add notes for tests | expand

Commit Message

Simone Weiß March 5, 2024, 4:46 p.m. UTC 
From: Simone Weiß <simone.p.weiss@posteo.com>

This adds some hints that and how changes should be tested when contributing.

Fixes [YOCTO #15412]

Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
---
v2: improve ptest wording and fix spelling
 .../contributor-guide/submit-changes.rst      | 37 ++++++++++++++++++-
 1 file changed, 35 insertions(+), 2 deletions(-)

Comments

Michael Opdenacker March 6, 2024, 9:04 a.m. UTC | #1 
Hi Simone

On 3/5/24 at 17:46, Simone Weiß wrote:
> From: Simone Weiß <simone.p.weiss@posteo.com>
>
> This adds some hints that and how changes should be tested when contributing.
>
> Fixes [YOCTO #15412]
>
> Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
> ---
> v2: improve ptest wording and fix spelling
>   .../contributor-guide/submit-changes.rst      | 37 ++++++++++++++++++-
>   1 file changed, 35 insertions(+), 2 deletions(-)

Thanks for the update.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.

Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 61f3157d6..59f3c1e40 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -221,6 +221,38 @@  to add the upgraded version.
    <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__
    in the Linux kernel documentation.
 
+Test your changes
+-----------------
+
+For each contributions you make, you should test your changes as well.
+For this the Yocto Project offers several types of tests. Those tests cover
+different areas and it depends on your changes which are feasible. For example run:
+
+   -  For changes that affect the build environment:
+
+      -  ``bitbake-selftest``: for changes within BitBake
+
+      -  ``oe-selftest``: to test combinations of BitBake runs
+
+      -  ``oe-build-perf-test``: to test the performance of common build scenarios
+
+   -  For changes in a recipe:
+
+      - ``ptest``: run package specific tests, if they exist
+
+      - ``testimage``: build an image, boot it and run testcases on it
+
+      - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds
+
+   -  For changes relating to the SDK:
+
+      - ``testsdk``: to build, install and run tests against a SDK
+
+      - ``testsdk_ext``: to build, install and run tests against an extended SDK
+
+Note that this list just gives suggestions and is not exhaustive. More details can
+be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`.
+
 Creating Patches
 ================
 
@@ -285,8 +317,9 @@  Validating Patches with Patchtest
 ``patchtest`` is available in ``openembedded-core`` as a tool for making
 sure that your patches are well-formatted and contain important info for
 maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status``
-tags. Currently, it only supports testing patches for
-``openembedded-core`` branches. To setup, perform the following::
+tags. Note that no functional testing of the changes will be performed by ``patchtest``.
+Currently, it only supports testing patches for ``openembedded-core`` branches.
+To setup, perform the following::
 
     pip install -r meta/lib/patchtest/requirements.txt
     source oe-init-build-env