summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
diff options
context:
space:
mode:
authorTrevor Gamblin <tgamblin@baylibre.com>2023-10-17 12:32:03 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-10-20 14:40:29 +0100
commit884c37f6fdb57d5cb8b66c748c5146c962fcd831 (patch)
tree8cb50ce25150bc79a07af2bc22940994033e18a3 /documentation/contributor-guide
parent544da7651db1f6a019f9c660f99eb012994b2a5a (diff)
downloadpoky-884c37f6fdb57d5cb8b66c748c5146c962fcd831.tar.gz
contributor-guide: clarify patchtest usage
- Make it clear that patchtest only supports openembedded-core for now - Add a short list of instructions for installing Python module dependencies on the host - Add a step to add meta-selftest with bitbake layers so that all tests can run (From yocto-docs rev: bcd58d68e72226be1930593f5f7fb37de15b7913) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.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.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 8a300c3664..53daaf901a 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -282,12 +282,18 @@ Here is the general procedure on how to create patches to be sent through email:
282Validating Patches with Patchtest 282Validating Patches with Patchtest
283================================= 283=================================
284 284
285``patchtest`` is available in ``openembedded-core`` as a tool for making sure 285``patchtest`` is available in ``openembedded-core`` as a tool for making
286that your patches are well-formatted and contain important info for 286sure that your patches are well-formatted and contain important info for
287maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status`` 287maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status``
288tags. Once you have generated the patch files and run ``source 288tags. Currently, it only supports testing patches for
289oe-init-build-env`` to initialize your workspace, you can run ``patchtest`` 289``openembedded-core`` branches. To setup, perform the following::
290like so:: 290
291 pip install -r meta/lib/patchtest/requirements.txt
292 source oe-init-build-env
293 bitbake-layers add-layer ../meta-selftest
294
295Once these steps are complete and you have generated your patch files,
296you can run ``patchtest`` like so::
291 297
292 patchtest --patch <patch_name> 298 patchtest --patch <patch_name>
293 299