[Linux-kernel-mentees] [PATCH RFC 0/3] docs: add documentation for checkpatch

Lukas Bulwahn lukas.bulwahn at gmail.com
Sun Jan 24 16:20:00 UTC 2021


On Sun, Jan 24, 2021 at 4:29 PM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
>
> On Sun, Jan 24, 2021 at 8:49 PM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
> >
> > This patch series serves to introduce a documentation for kernel script
> > checkpatch.pl (scripts/checkpatch.pl).
> >
> > A top level tools directory has been created in docs which shall contain
> > the documentation related to the kernel tools and scripts.
> >
> > This documentation shall be progressively updated by future patches to
> > document all the message types in checkpatch. Consecutively this
> > documentation itself will be parsed by checkpatch to generate verbose
> > messages.
> >
> > Dwaipayan Ray (3):
> >   docs: add documentation for checkpatch
> >   docs: add documentation for checkpatch
> >   docs: add documentation for checkpatch
> >
> >  Documentation/index.rst            |  11 ++
> >  Documentation/tools/checkpatch.rst | 271 +++++++++++++++++++++++++++++
> >  Documentation/tools/index.rst      |  10 ++
> >  3 files changed, 292 insertions(+)
> >  create mode 100644 Documentation/tools/checkpatch.rst
> >  create mode 100644 Documentation/tools/index.rst
> >
> > --
> > 2.30.0
> >
>
> Hey Lukas,
> This patch series serves to introduce the checkpatch documentation.
> A part of this documentation will be used by checkpatch, I am working
> on that right now. Subsequently all the message types can be documented
> slowly.
>
> The initial plan is to parse the part between
> .. CHECKPATCH_START and .. CHECKPATCH_END.
>

Plan sounds reasonable, we will refine as we go.

Go ahead and implement the checkpatch.pl feature to parse this file
and output the description, and send it as RFC to Joe as well, but
point out what is important to you for his opinion (I think you care
if the checkpatch.pl implementation can be done that way) and what
will we refine and completely rewrite as we move forward (the
documentation is really much more work in progress).

> As for the documentation itself, it would be great to have your review on it!
> I could send the pdfdocs as well if you need it.
>

All fine, I can pick this patch series and generate the documentation
locally myself.

Lukas


More information about the Linux-kernel-mentees mailing list