From 302c054d64a19c5bb579c3a74cc809f7338cf9de Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Tue, 20 Jan 2026 16:31:46 -0600 Subject: doc: develop: process: Document using b4 and patchwork for custodians - We already have good custodian documentation for patchwork, add a reference and then link to it here. - Add a reference to the existing b4 documentation, and reference it here. - Note and link to patchwork integration, am/shazam and ty features of b4 as these are the most likely useful portions. Be specific about keeping the default ${summary} as that includes important information. Signed-off-by: Tom Rini Reviewed-by: Mattijs Korpershoek Reviewed-by: Quentin Schulz --- doc/develop/process.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'doc/develop/process.rst') diff --git a/doc/develop/process.rst b/doc/develop/process.rst index f436a98433a..fd81d9c5ebd 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -232,6 +232,35 @@ feedback to the submitter of a patch about what is going on: work on an individual submitting a patch when something does not apply cleanly. +Tooling +^^^^^^^ + +There are a number of tools available to help custodians and +contributors alike with their contributions. As a project we make use of +the Patchwork project hosted at `OzLabs `__ +and more discussion on how it is used from both a contributor as well as +custodian point of view can be found :ref:`here `. + +Another useful tool is `b4 `__ +and is documented from a contributor point of view :ref:`here +`. It also has a number of useful features from a custodian +point of view: + +* `Integration with patchwork + `__ + which allows for automatic state tracking. + +* `"am" and "shazam" + `__ + for applying a patch or series of patches. Of note is that with + ``shazam`` review tags can be applied automatically and cover letters + can be integrated as part of merging a series. + +* `"ty" `__ for + automatically sending emails once patches have been applied. It is + strongly encouraged to keep the default ``${summary}`` in the template + as that shows what the git commit hash is for a particular patch. + Work flow of a Custodian ^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit v1.2.3