[Linux-kernel-mentees] [PATCH v4 2/2] docs: add documentation for checkpatch

Dwaipayan Ray dwaipayanray1 at gmail.com
Fri Feb 19 18:34:33 UTC 2021


On Fri, Feb 19, 2021 at 11:25 PM Joe Perches <joe at perches.com> wrote:
>
> On Wed, 2021-02-17 at 22:24 +0530, Dwaipayan Ray wrote:
> > Add documentation for kernel script checkpatch.pl.
> > This documentation is also parsed by checkpatch to
> > enable a verbose mode.
> >
> > The checkpatch message types are grouped by usage. Under
> > each group the types are described briefly. 34 of such
> > types are documented.
>
> Of course with more to come as you are work on them... ;)
>

Yes sure I will be documenting all the types, albeit with a bit of time.

> > diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> []
> > +    This applies for all non-functional blocks.
> > +    However, there is one special case, namely functions: they have the
> > +    opening brace at the beginning of the next line, thus::
> > +
> > +      int function(int x)
> > +      {
> > +        body of function
> > +      }
> > +
> > +    Ref: `Documentation/process/coding-style.rst section 3`
>
> Ideally, these Ref: entries should use a form with the specific section
> to jump to.  For example:
>
>         Ref: `https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces`
>
> Perhaps "See: " might be better than "Ref: "
>
>         See: `https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces`
>
> > +  **CODE_INDENT**
> > +    Code indent should use tabs instead of spaces.
> > +    Outside of comments, documentation and Kconfig,
> > +    spaces are never used for indentation.
> > +    Ref: `Documentation/process/coding-style.rst section 1`
>
>         See: `https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation`
>
> etc...
>
>

Okay, I will convert the references.
Thanks for the review!

With regards,
Dwaipayan.


More information about the Linux-kernel-mentees mailing list