Messages in this thread | | | Subject | Re: [PATCH RFC v3 2/3] docs: add documentation for checkpatch | From | Joe Perches <> | Date | Sun, 14 Feb 2021 08:57:40 -0800 |
| |
On Sat, 2021-02-13 at 18:45 +0530, Dwaipayan Ray wrote: > Add documentation for kernel script checkpatch.pl. > This documentation is also parsed by checkpatch to > enable a verbose mode. > > The message types in checkpatch are documented with rst > field lists. A total of 33 checkpatch type descriptions > are added.
Alphabetic ordering isn't that great for these entries. Please group them by use:
whitespace/code layout style: SPACING, TRAILING_WHITESPACE, LINE_SPACING
commit message defects: BAD_SIGN_OFF, BAD_STABLE_ADDRESS_STYLE, COMMIT_COMMENT_SYMBOL, COMMIT_MESSAGE
Allocation style: group: ALLOC_ARRAY_ARGS, ALLOC_SIZEOF_STRUCT, ALLOC_WITH_MULTIPLY
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst [] > +4 Type Descriptions > +------------------- > + > +This section contains a description of all the message types in checkpatch. > + > +.. Types in this section are also parsed by checkpatch. > +.. Please keep the types sorted alphabetically. > + > +:ALLOC_ARRAY_ARGS: > + The first argument for kcalloc or kmalloc_array should be the > + number of elements. sizeof() as the first argument is generally > + wrong.
If you look at the generated .html file, the output format is poor.
It would probably be better to use **<TYPE>** for each of these blocks instead of :<TYPE>:
and update the script appropriately.
| |