Re: [PATCH] docs: checkpatch: add some new checkpatch documentation messages

From: Bagas Sanjaya
Date: Tue Aug 02 2022 - 23:05:38 EST


Hi Utkarsh,

On Tue, Aug 02, 2022 at 11:25:28AM +0530, Utkarsh Verma wrote:
> Added and documented the following new message types:
> - JIFFIES_COMPARISON
> - LONG_UDELAY
> - MSLEEP
> - INDENTED_LABEL
> - IF_0
> - IF_1
> - MISORDERED_TYPE
> - UNNECESSARY_BREAK
> - UNNECESSARY_ELSE
> - UNNECESSARY_INT
> - UNSPECIFIED_INT
>

Use imperative mood for patch description instead.

> + **MISORDERED_TYPE**
> + According to section “6.7.2 Type Specifiers” in C90 standard, “type
> + specifiers may occur in any order.” This means that "signed long long
> + int" is same as "long long int signed". But to avoid confusion and make
> + the code easier to read, the declaration type should use the following
> + format::
> +
> + [[un]signed] [short|int|long|long long]
> +
> + Below is the list of standard integer types. Each row lists all the
> + different ways of specifying a particular type delimited by commas.
> + Note: Also include all the permutations of a particular type
> + on the left column delimited by comma. For example, the permutations
> + for "signed long int" are "signed int long", "long signed int",
> + "long int signed", "int signed long", and "int long signed".
> +
> + +--------------------------------------------------+--------------------+
> + | Types | Recommended Way |
> + +=======================================================================+
> + | char | char |
> + +-----------------------------------------------------------------------+
> + | signed char | signed char |
> + +-----------------------------------------------------------------------+
> + | unsigned char | unsigned char |
> + +-----------------------------------------------------------------------+
> + | signed, int, signed int | int |
> + +-----------------------------------------------------------------------+
> + | unsigned, unsigned int | unsigned int |
> + +-----------------------------------------------------------------------+
> + | short, signed short, short int, signed short int | short |
> + +-----------------------------------------------------------------------+
> + | unsigned short, unsigned short int | unsigned short |
> + +-----------------------------------------------------------------------+
> + | long, signed long, long int, signed long int | long |
> + +-----------------------------------------------------------------------+
> + | unsigned long, unsigned long int | unsigned long |
> + +-----------------------------------------------------------------------|
> + | long long, signed long long, long long int, | long long |
> + | signed long long int | |
> + +-----------------------------------------------------------------------+
> + | unsigned long long, unsigned long long int | unsigned long long |
> + +-----------------------------------------------------------------------+
> +

The table above triggers htmldocs error, so I have to apply the fixup:

---- >8 ----