diff options
| author | Roland Hieber <rhi@pengutronix.de> | 2022-09-05 13:07:08 +0200 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2022-09-05 16:27:24 +0200 |
| commit | bdbc29e43c934c8698ec1192d4f7a3f1a937611f (patch) | |
| tree | 4f5fd898b2fc788ea0112be0c9de3d177e5f7d80 | |
| parent | bfcae1894fa54afe3c1655d5f9a221396e6dea4c (diff) | |
| download | DistroKit-bdbc29e43c934c8698ec1192d4f7a3f1a937611f.tar.gz DistroKit-bdbc29e43c934c8698ec1192d4f7a3f1a937611f.tar.xz | |
doc: intro: document helper scripts
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Link: https://lore.pengutronix.de/20220905110709.1832516-5-rhi@pengutronix.de
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | doc/intro.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index 80625e7..2d4ec2f 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 ------- |