DistroKit Mailinglist
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: distrokit@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [DistroKit] [PATCH 5/6] doc: intro: document helper scripts
Date: Mon,  5 Sep 2022 13:07:08 +0200	[thread overview]
Message-ID: <20220905110709.1832516-5-rhi@pengutronix.de> (raw)
In-Reply-To: <20220905110709.1832516-1-rhi@pengutronix.de>

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 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




  parent reply	other threads:[~2022-09-05 11:07 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-05 11:07 [DistroKit] [PATCH 1/6] doc: hardware: fix malformed table Roland Hieber
2022-09-05 11:07 ` [DistroKit] [PATCH 2/6] doc: hardware: fix referencing nonexisting documents in toctree Roland Hieber
2022-09-05 11:07 ` [DistroKit] [PATCH 3/6] doc: hardware: document v7a_noneon platform Roland Hieber
2022-09-05 11:07 ` [DistroKit] [PATCH 4/6] doc: fix some typos Roland Hieber
2022-09-05 11:07 ` Roland Hieber [this message]
2022-09-05 11:07 ` [DistroKit] [PATCH 6/6] scripts: update-diffs-v7a.sh: fix ptxdist path Roland Hieber
2022-09-06  9:58   ` Jan Lübbe
2022-09-06 13:53     ` [DistroKit] [PATCH] fixup! doc: intro: document helper scripts Roland Hieber
2022-09-06 14:11       ` Robert Schwebel
2022-09-05 13:56 ` [DistroKit] [PATCH 1/6] doc: hardware: fix malformed table Robert Schwebel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220905110709.1832516-5-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=distrokit@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox