diff options
| author | Simon Glass <[email protected]> | 2026-07-05 13:32:13 -0600 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2026-07-06 08:28:50 -0600 |
| commit | f6c56009f6600ad87336484d258849d2bf36d010 (patch) | |
| tree | 87e323e2703a19722d2242810fb828431a5d6079 /doc/develop | |
| parent | 08183ba1af1953c1a4dcdea94d1f6d8f4b5254b3 (diff) | |
doc: Remove the patman documentation
The full patman manual now lives with the standalone patch-manager
package, making the 1000-line copy in the tree redundant.
Remove the in-tree manual, its README and the doc/develop/patman.rst
toctree page.
The sending-patches guide already introduces patman, so point it at the
patch-manager package instead of the now-dead ':doc:' cross-reference
and, with the manual gone, add a couple of lines on how the tool works.
Point the SPI howto at that guide too, rather than repeating the install
details.
Signed-off-by: Simon Glass <[email protected]>
Reviewed-by: Tom Rini <[email protected]>
Reviewed-by: Mattijs Korpershoek <[email protected]>
Diffstat (limited to 'doc/develop')
| -rw-r--r-- | doc/develop/driver-model/spi-howto.rst | 4 | ||||
| -rw-r--r-- | doc/develop/index.rst | 1 | ||||
| l--------- | doc/develop/patman.rst | 1 | ||||
| -rw-r--r-- | doc/develop/sending_patches.rst | 10 |
4 files changed, 10 insertions, 6 deletions
diff --git a/doc/develop/driver-model/spi-howto.rst b/doc/develop/driver-model/spi-howto.rst index 9dc3b9b4aac..65dd50e7d55 100644 --- a/doc/develop/driver-model/spi-howto.rst +++ b/doc/develop/driver-model/spi-howto.rst @@ -649,8 +649,8 @@ board. Prepare patches and send them to the mailing lists -------------------------------------------------- -You can use 'tools/patman/patman' to prepare, check and send patches for -your work. See tools/patman/README for details. +You can prepare, check and send patches for your work using the tools described +in :doc:`/develop/sending_patches`. A little note about SPI uclass features --------------------------------------- diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 3c044e67927..51fd68fa04b 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -16,7 +16,6 @@ General docstyle kconfig memory - patman process release_cycle security diff --git a/doc/develop/patman.rst b/doc/develop/patman.rst deleted file mode 120000 index 0fcb7d61d40..00000000000 --- a/doc/develop/patman.rst +++ /dev/null @@ -1 +0,0 @@ -../../tools/patman/patman.rst
\ No newline at end of file diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 85f3003074f..c3e0ef27824 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -73,9 +73,15 @@ Using patman You can use a tool called patman to prepare, check and send patches. It creates change logs, cover letters and patch notes. It also simplifies the process of -sending multiple versions of a series. +sending multiple versions of a series. patman is driven by tags in your commit +messages, and can collect Reviewed-by and other tags from patchwork when you +send a new version. It can optionally keep a local database of all your series, +tracking each version and their review / applied status over time, so you can +easily track upstreaming progress. -See more details at :doc:`patman`. +patman now lives outside the U-Boot tree; install it with +``pip install patch-manager``. See the +`patman documentation <https://deinde.dev/patman>`_ for details. General Patch Submission Rules ------------------------------ |