From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Mon, 05 Sep 2022 13:07:24 +0200 Received: from metis.ext.pengutronix.de ([2001:67c:670:201:290:27ff:fe1d:cc33]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1oV9wp-007QF8-4M for lore@lore.pengutronix.de; Mon, 05 Sep 2022 13:07:24 +0200 Received: from localhost ([127.0.0.1] helo=metis.ext.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1oV9wo-0001sY-If; Mon, 05 Sep 2022 13:07:22 +0200 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.ext.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oV9wf-0001qk-0S; Mon, 05 Sep 2022 13:07:13 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtp (Exim 4.94.2) (envelope-from ) id 1oV9wc-0042n2-DD; Mon, 05 Sep 2022 13:07:12 +0200 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.94.2) (envelope-from ) id 1oV9wd-007gkq-AP; Mon, 05 Sep 2022 13:07:11 +0200 From: Roland Hieber To: distrokit@pengutronix.de Date: Mon, 5 Sep 2022 13:07:08 +0200 Message-Id: <20220905110709.1832516-5-rhi@pengutronix.de> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220905110709.1832516-1-rhi@pengutronix.de> References: <20220905110709.1832516-1-rhi@pengutronix.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [DistroKit] [PATCH 5/6] doc: intro: document helper scripts X-BeenThere: distrokit@pengutronix.de X-Mailman-Version: 2.1.29 Precedence: list List-Id: DistroKit Mailinglist List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Roland Hieber Sender: "DistroKit" X-SA-Exim-Connect-IP: 127.0.0.1 X-SA-Exim-Mail-From: distrokit-bounces@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false Signed-off-by: Roland Hieber --- doc/intro.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/intro.rst b/doc/intro.rst index 80625e73553a..e785f5832b5d 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -116,6 +116,22 @@ using your real name (sorry, no pseudonyms or anonymous contributions) to the end of your commit message, or if you use Git, make your commit with ``git commit --signoff``. +Maintenance scripts +~~~~~~~~~~~~~~~~~~~ + +Before sending your patch, you should run ``ptxdist lint`` and check its output. +Your patch should not add any new lint errors. + +For migrating PTXdist to a new version, there is the wrapper script +``scripts/p-all`` that runs PTXdist with the supplied arguments on all existing +platforms in DistroKit, for example:: + + $ ./scripts/p-all migrate + +The *mips* and *v7a* platforms use config diffs for kernel and/or barebox packages. +When touching their config files, you can use ``scripts/update-diffs-mips.sh`` and +``scripts/update-diffs-v7a.sh`` respectively to update the config diffs. + License ------- -- 2.30.2