diff options
author | Simone Weiß <simone.p.weiss@posteo.com> | 2024-03-05 16:46:51 +0000 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2024-03-25 04:11:26 -1000 |
commit | ccb4e6abb480c90811130fa11570948f5d11ac1c (patch) | |
tree | 9dec1946ae779d5d7c71823797d67b98b502ac05 | |
parent | 5b75b5cbcf48845d4c4f740ac53ec50db20285db (diff) | |
download | poky-ccb4e6abb480c90811130fa11570948f5d11ac1c.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: 649843f4d20d1d840e1c6c4ce15e89b3a8508e0f)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 32 |
1 files changed, 32 insertions, 0 deletions
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. | |||
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 | ||
224 | Test your changes | ||
225 | ----------------- | ||
226 | |||
227 | For each contributions you make, you should test your changes as well. | ||
228 | For this the Yocto Project offers several types of tests. Those tests cover | ||
229 | different 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 | |||
253 | Note that this list just gives suggestions and is not exhaustive. More details can | ||
254 | be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`. | ||
255 | |||
224 | Creating Patches | 256 | Creating Patches |
225 | ================ | 257 | ================ |
226 | 258 | ||