public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: "Michael Opdenacker" <michael.opdenacker@bootlin.com>,
	"Simone Weiß" <simone.p.weiss@posteo.com>
Subject: [kirkstone][PATCH 7/8] contributor-guide: add notes for tests
Date: Thu, 14 Mar 2024 10:13:57 +0100	[thread overview]
Message-ID: <20240314091358.84025-8-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20240314091358.84025-1-michael.opdenacker@bootlin.com>

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 .../contributor-guide/submit-changes.rst      | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 319f41b51f..c0f2aa7cb4 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
 ================
 
-- 
2.34.1



  parent reply	other threads:[~2024-03-14  9:14 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-14  9:13 [kirkstone][PATCH 0/8] documentation backports michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 1/8] ref-manual: tasks: do_cleanall: recommend using '-f' instead michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 2/8] ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 3/8] ref-manual: variables: correct sdk installation default path michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 4/8] ref-manual: variables: adding multiple groups in GROUPADD_PARAM michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 5/8] dev-manual: packages: fix capitalization michael.opdenacker
2024-03-14  9:13 ` [kirkstone][PATCH 6/8] manuals: replace hyphens with em dashes michael.opdenacker
2024-03-14  9:13 ` michael.opdenacker [this message]
2024-03-14  9:13 ` [kirkstone][PATCH 8/8] manuals: document VIRTUAL-RUNTIME variables michael.opdenacker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240314091358.84025-8-michael.opdenacker@bootlin.com \
    --to=michael.opdenacker@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=simone.p.weiss@posteo.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox