| Message ID | 20231017163203.2268267-1-tgamblin@baylibre.com |
|---|---|
| State | New |
| Headers | show |
| Series | contributor-guide: clarify patchtest usage | expand |
Hi Trevor On 17.10.23 at 18:32, Trevor Gamblin wrote: > - 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 > > Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> > --- > .../contributor-guide/submit-changes.rst | 16 +++++++++++----- > 1 file changed, 11 insertions(+), 5 deletions(-) > > diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst > index 8a300c366..f93c87ca3 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: > 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 > +``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:: > +tags. Currently, it only supports testing patches for > +``openembedded-core`` branches. To setup, perform the following:: > + > +#. ``pip install -r meta/lib/patchtest/requirements.txt`` > +#. ``source oe-init-build-env`` > +#. ``bitbake-layers add-layer ../meta-selftest`` Thanks for the update. I just removed the "#." characters which made the output look weird. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Merged into "master-next". Cheers Michael.
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 8a300c366..f93c87ca3 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: 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 +``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:: +tags. Currently, it only supports testing patches for +``openembedded-core`` branches. To setup, perform the following:: + +#. ``pip install -r meta/lib/patchtest/requirements.txt`` +#. ``source oe-init-build-env`` +#. ``bitbake-layers add-layer ../meta-selftest`` + +Once these steps are complete and you have generated your patch files, +you can run ``patchtest`` like so:: patchtest --patch <patch_name>
- 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 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> --- .../contributor-guide/submit-changes.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-)