diff options
| author | Tom Rini <[email protected]> | 2026-01-20 16:31:46 -0600 |
|---|---|---|
| committer | Heinrich Schuchardt <[email protected]> | 2026-01-28 21:20:07 +0100 |
| commit | 302c054d64a19c5bb579c3a74cc809f7338cf9de (patch) | |
| tree | 278838b45184bd99548ca366b99f5a6c0bc8c80e /doc | |
| parent | e41a8f3f35ed870921c913a87eb9d5919112a8f3 (diff) | |
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 <[email protected]>
Reviewed-by: Mattijs Korpershoek <[email protected]>
Reviewed-by: Quentin Schulz <[email protected]>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/develop/codingstyle.rst | 2 | ||||
| -rw-r--r-- | doc/develop/process.rst | 29 | ||||
| -rw-r--r-- | doc/develop/sending_patches.rst | 2 |
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst index 7304eea0056..2a69162fa95 100644 --- a/doc/develop/codingstyle.rst +++ b/doc/develop/codingstyle.rst @@ -24,6 +24,8 @@ The following rules apply: <https://peps.python.org/pep-0008/>`_. Use `pylint <https://github.com/pylint-dev/pylint>`_ for checking the code. +.. _b4_contrib: + * Use the `b4 <https://b4.docs.kernel.org/en/latest/>`__ tool to prepare and send your patches. b4 has become the preferred tool to sending patches for many Linux kernel contributors, and U-Boot ships with a ready-to-use ``.b4-config`` that 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 <http://patchwork.ozlabs.org/>`__ +and more discussion on how it is used from both a contributor as well as +custodian point of view can be found :ref:`here <patchwork>`. + +Another useful tool is `b4 <https://b4.docs.kernel.org/en/latest/>`__ +and is documented from a contributor point of view :ref:`here +<b4_contrib>`. It also has a number of useful features from a custodian +point of view: + +* `Integration with patchwork + <https://b4.docs.kernel.org/en/latest/config.html#patchwork-integration-settings>`__ + which allows for automatic state tracking. + +* `"am" and "shazam" + <https://b4.docs.kernel.org/en/latest/maintainer/am-shazam.html>`__ + 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" <https://b4.docs.kernel.org/en/latest/maintainer/ty.html>`__ 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 ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 53c7655b2c3..e29fa175727 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -322,6 +322,8 @@ Notes the memory footprint of the code. Remember: Small is beautiful! When adding new features follow the guidelines laid out in :doc:`system_configuration`. +.. _patchwork: + Patch Tracking -------------- |
