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

Lukas Bulwahn lukas.bulwahn at gmail.com
Sun Jan 24 16:51:39 UTC 2021


On Sun, Jan 24, 2021 at 4:19 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.
>

Just a quick pointer:

I know there was once some documentation at:

https://folk.universitetetioslo.no/knuto/kernel/4.14/dev-tools/run-checkpatch.html

... but now I just checked and it is gone... Knut Omang (the author)
probably left the university.

I could not find it anywhere else;  Maybe you can reach out to him and
ask if he still has those Documentation files around?

It could be useful to reuse his documentation, although it was never merged.

Lukas

> 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
>


More information about the Linux-kernel-mentees mailing list