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

Dwaipayan Ray dwaipayanray1 at gmail.com
Sun Jan 24 15:29:19 UTC 2021


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.

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.

Thank you,
Dwaipayan.


More information about the Linux-kernel-mentees mailing list