[PATCH 5/9] patman: Replace the documentation with a stub

[Simon Glass]

Hi Peter,

On Tue, 16 Jun 2026 at 21:38, Peter Robinson <pbrobinson at gmail.com> wrote:
>
> On Tue, 16 Jun 2026 at 15:39, Simon Glass <sjg at chromium.org> wrote:
> >
> > The full patman manual now lives with the standalone patch-manager
> > package, making the 1000-line copy in the tree redundant. Its published
> > page is a long-standing URL, though, so removing it outright would break
> > existing links.
> >
> > Replace the in-tree manual with a short stub that points readers at the
> > patch-manager package, and keep the toctree entry so the page still
> > builds. Drop the README and the tool's own rst, and point the
> > patch-sending docs at the standalone package too.
> >
> > Signed-off-by: Simon Glass <sjg at chromium.org>
> > ---
> >
> >  doc/develop/driver-model/spi-howto.rst |    5 +-
> >  doc/develop/patman.rst                 |   15 +-
> >  doc/develop/sending_patches.rst        |    4 +-
> >  tools/patman/README.rst                |    1 -
> >  tools/patman/patman.rst                | 1023 ------------------------
> >  5 files changed, 20 insertions(+), 1028 deletions(-)
> >  mode change 120000 => 100644 doc/develop/patman.rst
> >  delete mode 120000 tools/patman/README.rst
> >  delete mode 100644 tools/patman/patman.rst
> >
> > diff --git a/doc/develop/driver-model/spi-howto.rst b/doc/develop/driver-model/spi-howto.rst
> > index 9dc3b9b4aac..c5b07ba0e47 100644
> > --- a/doc/develop/driver-model/spi-howto.rst
> > +++ b/doc/develop/driver-model/spi-howto.rst
> > @@ -649,8 +649,9 @@ 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 use the patman tool to prepare, check and send patches for your work.
> > +Install it with ``pip install patch-manager``; see the
> > +`patman documentation <https://deinde.dev/patman>`_.
>
> So this URL seems weird, and it redirects to
> https://patman.readthedocs.io/en/latest/
>
> If I search for patch-manager on pypi.org the project goes to
> https://github.com/nxtboot/patman
>
> May I suggest that deinde.dev and nxtboot and patman and patch-manager
> as different names all feel disconnected, maybe some consistency
> around patman for the URLs, even if the github project is nxtboot, may
> provide less confusion for the users.

Yes I agree and I would like to, but it's a matter of what is available:

- patman is used for something else on pypi
- nextboot and deinde are taken on github

I didn't cconsider using patch-manager as the github name, but that
seems wrong because everyone thinks of it as 'patman'. It is somewhat
of a mess, but I'm open to suggestions.

[..]

Regards,
Simon