diff mbox series

contributor-guide/submit-changes.rst: remove mention of Upstream-Status

Message ID 20251202-remove-upstream-status-mention-v1-1-410d15493349@bootlin.com
State Accepted
Headers show
Series contributor-guide/submit-changes.rst: remove mention of Upstream-Status | expand

Commit Message

Antonin Godard Dec. 2, 2025, 5 p.m. UTC
The Upstream-Status tag is not used for patches sent on mailing lists,
but for patches to be applied to recipes. To avoid confusion in this
Contributor Guide, remove the mention of this tag as part of the
Patchtest examples as it can be misinterpreted as something to include
in a regular patch.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/contributor-guide/submit-changes.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)


---
base-commit: b1e93125d81a35e5f566ea67ae9a827d6d94913f
change-id: 20251202-remove-upstream-status-mention-1e1c424395e1

Comments

Quentin Schulz Dec. 3, 2025, 3:14 p.m. UTC | #1
Hi Antonin,

On 12/2/25 6:00 PM, Antonin Godard via lists.yoctoproject.org wrote:
> The Upstream-Status tag is not used for patches sent on mailing lists,

It should be, for patches within the patches sent on the mailing list.

> but for patches to be applied to recipes. To avoid confusion in this
> Contributor Guide, remove the mention of this tag as part of the
> Patchtest examples as it can be misinterpreted as something to include
> in a regular patch.
> 

But I guess this rewording is fine, the error would be shown by running 
the script anyway so we don't need to list some or all errors it may return.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
Antonin Godard Dec. 16, 2025, 4:12 p.m. UTC | #2
On Tue, 02 Dec 2025 18:00:30 +0100, Antonin Godard wrote:
> The Upstream-Status tag is not used for patches sent on mailing lists,
> but for patches to be applied to recipes. To avoid confusion in this
> Contributor Guide, remove the mention of this tag as part of the
> Patchtest examples as it can be misinterpreted as something to include
> in a regular patch.
> 
> 
> [...]

Applied, thanks!

[1/1] contributor-guide/submit-changes.rst: remove mention of Upstream-Status
      commit: 23098728b57520d1d8e417500009279226ce8080

Best regards,
--
diff mbox series

Patch

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 0c2120eb0..6306ed45b 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -329,10 +329,10 @@  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. Note that no functional testing of the changes will be performed by ``patchtest``.
-Currently, it only supports testing patches for ``openembedded-core`` branches.
-To setup, perform the following::
+maintenance purposes, such as the ``Signed-off-by`` presence. Note that no
+functional testing of the changes will be performed by ``patchtest``. 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