From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Wed, 05 Feb 2025 13:09:52 +0100 Received: from metis.whiteo.stw.pengutronix.de ([2a0a:edc0:2:b01:1d::104]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tfeE4-008n3F-0F for lore@lore.pengutronix.de; Wed, 05 Feb 2025 13:09:52 +0100 Received: from localhost ([127.0.0.1] helo=metis.whiteo.stw.pengutronix.de) by metis.whiteo.stw.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1tfeE4-00075y-I9; Wed, 05 Feb 2025 13:09:52 +0100 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tfeDo-00075j-3G; Wed, 05 Feb 2025 13:09:36 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tfeDn-003dJI-2x; Wed, 05 Feb 2025 13:09:35 +0100 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tfeDn-009yu3-2o; Wed, 05 Feb 2025 13:09:35 +0100 From: Roland Hieber To: ptxdist@pengutronix.de Date: Wed, 5 Feb 2025 13:09:22 +0100 Message-Id: <20250205120922.2379021-1-rhi@pengutronix.de> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 Mail-Followup-To: Roland Hieber , ptxdist@pengutronix.de Content-Transfer-Encoding: 8bit Subject: [ptxdist] [PATCH] [RFC] doc/contributing: require Upstream-Status: headers for new patches X-BeenThere: ptxdist@pengutronix.de X-Mailman-Version: 2.1.29 Precedence: list List-Id: PTXdist Development Mailing List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: ptxdist@pengutronix.de Cc: Roland Hieber Sender: "ptxdist" X-SA-Exim-Connect-IP: 127.0.0.1 X-SA-Exim-Mail-From: ptxdist-bounces@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false The amount of patches in the patches/ folder in PTXdist has grown over the years, and for most of them it is hard to track whether they have already been applied upstream, or denied by the maintainer, or if they are otherwise inappropriate for upstream submission. To simplify the migration process to a new package version, any patches should include appropriate documentation about their relation to the upstream source. the Yocto Project already has a syntax for that; let's re-use that for PTXdist too. This way patches can also easily be cherry-picked between the two projects. Signed-off-by: Roland Hieber --- doc/contributing.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/contributing.rst b/doc/contributing.rst index 63da67802222..1b0b0804b6ce 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -145,6 +145,16 @@ in mind: ``_LICENSE`` variable if necessary. Often the difference is only in the copyright year, but in any case, describe the changes in the license file when sending your patch! +- When adding new patches to a package (in ``patches/``), these patches must + carry ``Upstream-Status:`` pseudo-headers to track the state of the patches + and give more context for the change in relation to the upstream source. + Refer to `Yocto Project's documentation `_ regarding + the syntax of these pseudo-headers. (Note: instead of the ``oe specific`` + keyword, use ``ptxdist specific``.) + + Adding such headers for existing patches is good practise, but not required. + +.. _patch-upstream-status: https://docs.yoctoproject.org/contributor-guide/recipe-style-guide.html#patch-upstream-status Misc ~~~~ -- 2.39.5