[PATCH v2 2/2] patman: Add documentation to doc/

[Simon Glass]

Hi Ralph,

On Mon, 15 Aug 2022 at 08:41, Ralph Siemsen <ralph.siemsen at linaro.org> wrote:
>
> Hello Heinrich,
>
> FYI, I had some trouble trying to apply your changes (patch seems to
> be mangled?).
>
> Only one small question for you, see below.
>
> On Wed, Aug 10, 2022 at 2:42 AM Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
> >
> > diff --git a/tools/patman/patman.rst b/tools/patman/patman.rst
> > index 52151f6f16..f2e6d7636f 100644
> > --- a/tools/patman/patman.rst
> > +++ b/tools/patman/patman.rst
> > @@ -1,19 +1,31 @@
> >   .. SPDX-License-Identifier: GPL-2.0+
> >   .. Copyright (c) 2011 The Chromium OS Authors
> > +.. Simon Glass <sjg at chromium.org>
> > +.. v1, v2, 19-Oct-11
> > +.. revised v3 24-Nov-11
> > +.. revised v4 04-Jul-2020, with Patchwork integration
> >
> >   Patman patch manager
> >   ====================
> >
> >   This tool is a Python script which:
> > +
> >   - Creates patch directly from your branch
> > +
> >   - Cleans them up by removing unwanted tags
> > +
> >   - Inserts a cover letter with change lists
> > +
> >   - Runs the patches through checkpatch.pl and its own checks
> > +
> >   - Optionally emails them out to selected people
> >
> >   It also has some Patchwork features:
> > +
> >   - shows review tags from Patchwork so you can update your local patches
> > +
> >   - pulls these down into a new branch on request
> > +
> >   - lists comments received on a series
> >
> >   It is intended to automate patch creation and make it a less
> > @@ -41,12 +53,15 @@ This tool requires a certain way of working:
> >
> >   - Maintain a number of branches, one for each patch series you are
> >     working on
> > +
> >   - Add tags into the commits within each branch to indicate where the
> >     series should be sent, cover letter, version, etc. Most of these are
> >     normally in the top commit so it is easy to change them with 'git
> >     commit --amend'
> > +
> >   - Each branch tracks the upstream branch, so that this script can
> >     automatically determine the number of commits in it (optional)
> > +
> >   - Check out a branch, and run this script to create and send out your
> >     patches. Weeks later, change the patches and repeat, knowing that you
> >     will get a consistent result each time.
>
> Is it necessary to have a blank line between each of the "bullet"
> points? It seems to work fine as long as there is one blank line
> separating the paragraph from the first bullet item.

It seems not, I will take a look.

>
> Otherwise, it looks good to me.

Regards,
Simon