MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

contributor-guide: add patchtest section

Browse Source 
(From yocto-docs rev: 236cd04d62bdf653aae9b41d32d9f87848a34339)

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>
This commit is contained in:
Trevor Gamblin 2023-10-17 09:38:25 -04:00 committed by Richard Purdie
parent 104899f390
commit 544da7651d
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
documentation/contributor-guide/submit-changes.rst
View File

@ -279,6 +279,40 @@ Here is the general procedure on how to create patches to be sent through email:
If necessary, rework your commits as described in
":ref:`contributor-guide/submit-changes:taking patch review into account`".
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. Once you have generated the patch files and run ``source
oe-init-build-env`` to initialize your workspace, you can run ``patchtest``
like so::
patchtest --patch <patch_name>
Alternatively, if you want ``patchtest`` to iterate over and test
multiple patches stored in a directory, you can use::
patchtest --directory <directory_name>
By default, ``patchtest`` uses its own modules' file paths to determine what
repository and test suite to check patches against. If you wish to test
patches against a repository other than ``openembedded-core`` and/or use
a different set of tests, you can use the ``--repodir`` and ``--testdir``
flags::
patchtest --patch <patch_name> --repodir <path/to/repo> --testdir <path/to/testdir>
Finally, note that ``patchtest`` is designed to test patches in a standalone
way, so if your patches are meant to apply on top of changes made by
previous patches in a series, it is possible that ``patchtest`` will report
false failures regarding the "merge on head" test.
Using ``patchtest`` in this manner provides a final check for the overall
quality of your changes before they are submitted for review by the
maintainers.
Sending the Patches via Email
=============================