summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
diff options
context:
space:
mode:
authorSimone Weiß <simone.p.weiss@posteo.com>2024-03-05 16:46:51 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-06 16:54:54 +0000
commitf9e1cfe9e871d6e2e06fd4881a963fe4d93cd8cf (patch)
treef01304c17a9dac336d2737f1271ab6eda18b4f69 /documentation/contributor-guide
parentc2fd0446ec49c271a9336846f1070fb5b52e995e (diff)
downloadpoky-f9e1cfe9e871d6e2e06fd4881a963fe4d93cd8cf.tar.gz
contributor-guide: add notes for tests
This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/contributor-guide')
-rw-r--r--documentation/contributor-guide/submit-changes.rst37
1 files changed, 35 insertions, 2 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 61f3157d60..59f3c1e406 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -221,6 +221,38 @@ to add the upgraded version.
221 <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ 221 <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__
222 in the Linux kernel documentation. 222 in the Linux kernel documentation.
223 223
224Test your changes
225-----------------
226
227For each contributions you make, you should test your changes as well.
228For this the Yocto Project offers several types of tests. Those tests cover
229different areas and it depends on your changes which are feasible. For example run:
230
231 - For changes that affect the build environment:
232
233 - ``bitbake-selftest``: for changes within BitBake
234
235 - ``oe-selftest``: to test combinations of BitBake runs
236
237 - ``oe-build-perf-test``: to test the performance of common build scenarios
238
239 - For changes in a recipe:
240
241 - ``ptest``: run package specific tests, if they exist
242
243 - ``testimage``: build an image, boot it and run testcases on it
244
245 - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds
246
247 - For changes relating to the SDK:
248
249 - ``testsdk``: to build, install and run tests against a SDK
250
251 - ``testsdk_ext``: to build, install and run tests against an extended SDK
252
253Note that this list just gives suggestions and is not exhaustive. More details can
254be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`.
255
224Creating Patches 256Creating Patches
225================ 257================
226 258
@@ -285,8 +317,9 @@ Validating Patches with Patchtest
285``patchtest`` is available in ``openembedded-core`` as a tool for making 317``patchtest`` is available in ``openembedded-core`` as a tool for making
286sure that your patches are well-formatted and contain important info for 318sure that your patches are well-formatted and contain important info for
287maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status`` 319maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status``
288tags. Currently, it only supports testing patches for 320tags. Note that no functional testing of the changes will be performed by ``patchtest``.
289``openembedded-core`` branches. To setup, perform the following:: 321Currently, it only supports testing patches for ``openembedded-core`` branches.
322To setup, perform the following::
290 323
291 pip install -r meta/lib/patchtest/requirements.txt 324 pip install -r meta/lib/patchtest/requirements.txt
292 source oe-init-build-env 325 source oe-init-build-env