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

[Simon Glass]

Hi Heinrich,

On Wed, 10 Aug 2022 at 00:47, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
> On 8/9/22 21:49, Simon Glass wrote:
> > Link to patman's documentation from the doc/ directory so that it appears
> > in the 'make htmldocs' output.
> >
> > Signed-off-by: Simon Glass <sjg at chromium.org>
> > ---
> >
> > Changes in v2:
> > - Fix up access to help from patman tool
> >
> >   doc/develop/index.rst               |   1 +
> >   doc/develop/patman.rst              |   1 +
> >   doc/develop/sending_patches.rst     |  16 +
> >   tools/patman/README.rst             |   1 +
> >   tools/patman/main.py                |   3 +-
> >   tools/patman/{README => patman.rst} | 526 ++++++++++++++--------------
> >   6 files changed, 287 insertions(+), 261 deletions(-)
> >   create mode 120000 doc/develop/patman.rst
> >   create mode 100644 doc/develop/sending_patches.rst
> >   create mode 120000 tools/patman/README.rst
> >   rename tools/patman/{README => patman.rst} (52%)
> >
> > diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> > index 7c41e3f1b6e..7476f9ca0eb 100644
> > --- a/doc/develop/index.rst
> > +++ b/doc/develop/index.rst
> > @@ -14,6 +14,7 @@ General
> >      process
> >      release_cycle
> >      system_configuration
> > +   sending_patcheshis
> >
> >   Implementation
> >   --------------
> > diff --git a/doc/develop/patman.rst b/doc/develop/patman.rst
> > new file mode 120000
> > index 00000000000..0fcb7d61d40
> > --- /dev/null
> > +++ b/doc/develop/patman.rst
> > @@ -0,0 +1 @@
> > +../../tools/patman/patman.rst
> > \ No newline at end of file
> > diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> > new file mode 100644
> > index 00000000000..0542adeaed9
> > --- /dev/null
> > +++ b/doc/develop/sending_patches.rst
>
> Thanks for moving this to the HTML documentation.
>
> This files contains numerous formatting errors which are not covered by
> your diff. It is worthwhile to look at the output of 'make htmldocs'.

Yes that's how I found the problems, but clearly not all of them and I
have not bothered with the bash code-block thing. I will start using
it more.

>
> May I apply the following when merging?

Yes, thanks.

>
> Do we need the incomplete changelog?

I prefer to keep it.

>
> By the way, Independence Day 2020 depends on the country the reader
> lives in, August 15th in India.

Thanks for the info but I don't live in India :-)

Regards,
Simon