Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Wed, 3 Aug 2022 08:24:06 +0800
From:   kernel test robot <lkp@intel.com>
To:     Utkarsh Verma <utkarshverma294@gmail.com>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc:     kbuild-all@lists.01.org, Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        Joe Perches <joe@perches.com>,
        Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Utkarsh Verma <utkarshverma294@gmail.com>
Subject: Re: [PATCH] docs: checkpatch: add some new checkpatch documentation
 messages
Message-ID: <202208030829.xj2bvI7P-lkp@intel.com>
References: <20220802055528.13726-1-utkarshverma294@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20220802055528.13726-1-utkarshverma294@gmail.com>
Precedence: bulk

Hi Utkarsh,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on lwn/docs-next]
[also build test ERROR on linus/master v5.19 next-20220728]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Utkarsh-Verma/docs-checkpatch-add-some-new-checkpatch-documentation-messages/20220802-135802
base:   git://git.lwn.net/linux.git docs-next
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@intel.com>

All error/warnings (new ones prefixed by >>):

>> Documentation/dev-tools/checkpatch.rst:1393: (SEVERE/4) Unexpected section title or transition.
>> Documentation/dev-tools/checkpatch.rst:1393: WARNING: Block quote ends without a blank line; unexpected unindent.
>> Documentation/dev-tools/checkpatch.rst:1393: WARNING: Unexpected section title or transition.

vim +1393 Documentation/dev-tools/checkpatch.rst

  1302	
  1303	  **CONFIG_DESCRIPTION**
  1304	    Kconfig symbols should have a help text which fully describes
  1305	    it.
  1306	
  1307	  **CORRUPTED_PATCH**
  1308	    The patch seems to be corrupted or lines are wrapped.
  1309	    Please regenerate the patch file before sending it to the maintainer.
  1310	
  1311	  **CVS_KEYWORD**
  1312	    Since linux moved to git, the CVS markers are no longer used.
  1313	    So, CVS style keywords ($Id$, $Revision$, $Log$) should not be
  1314	    added.
  1315	
  1316	  **DEFAULT_NO_BREAK**
  1317	    switch default case is sometimes written as "default:;".  This can
  1318	    cause new cases added below default to be defective.
  1319	
  1320	    A "break;" should be added after empty default statement to avoid
  1321	    unwanted fallthrough.
  1322	
  1323	  **DOS_LINE_ENDINGS**
  1324	    For DOS-formatted patches, there are extra ^M symbols at the end of
  1325	    the line.  These should be removed.
  1326	
  1327	  **DT_SCHEMA_BINDING_PATCH**
  1328	    DT bindings moved to a json-schema based format instead of
  1329	    freeform text.
  1330	
  1331	    See: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html
  1332	
  1333	  **DT_SPLIT_BINDING_PATCH**
  1334	    Devicetree bindings should be their own patch.  This is because
  1335	    bindings are logically independent from a driver implementation,
  1336	    they have a different maintainer (even though they often
  1337	    are applied via the same tree), and it makes for a cleaner history in the
  1338	    DT only tree created with git-filter-branch.
  1339	
  1340	    See: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters
  1341	
  1342	  **EMBEDDED_FILENAME**
  1343	    Embedding the complete filename path inside the file isn't particularly
  1344	    useful as often the path is moved around and becomes incorrect.
  1345	
  1346	  **FILE_PATH_CHANGES**
  1347	    Whenever files are added, moved, or deleted, the MAINTAINERS file
  1348	    patterns can be out of sync or outdated.
  1349	
  1350	    So MAINTAINERS might need updating in these cases.
  1351	
  1352	  **MEMSET**
  1353	    The memset use appears to be incorrect.  This may be caused due to
  1354	    badly ordered parameters.  Please recheck the usage.
  1355	
  1356	  **MISORDERED_TYPE**
  1357	    According to section “6.7.2 Type Specifiers” in C90 standard, “type
  1358	    specifiers may occur in any order.” This means that "signed long long
  1359	    int" is same as "long long int signed". But to avoid confusion and make
  1360	    the code easier to read, the declaration type should use the following
  1361	    format::
  1362	
  1363	      [[un]signed] [short|int|long|long long]
  1364	
  1365	    Below is the list of standard integer types. Each row lists all the
  1366	    different ways of specifying a particular type delimited by commas.
  1367	    Note: Also include all the permutations of a particular type
  1368	    on the left column delimited by comma. For example, the permutations
  1369	    for "signed long int" are "signed int long", "long signed int",
  1370	    "long int signed", "int signed long", and "int long signed".
  1371	
  1372	    +--------------------------------------------------+--------------------+
  1373	    |                       Types                      |   Recommended Way  |
  1374	    +=======================================================================+
  1375	    | char                                             | char               |
  1376	    +-----------------------------------------------------------------------+
  1377	    | signed char                                      | signed char        |
  1378	    +-----------------------------------------------------------------------+
  1379	    | unsigned char                                    | unsigned char      |
  1380	    +-----------------------------------------------------------------------+
  1381	    | signed, int, signed int                          | int                |
  1382	    +-----------------------------------------------------------------------+
  1383	    | unsigned, unsigned int                           | unsigned int       |
  1384	    +-----------------------------------------------------------------------+
  1385	    | short, signed short, short int, signed short int | short              |
  1386	    +-----------------------------------------------------------------------+
  1387	    | unsigned short, unsigned short int               | unsigned short     |
  1388	    +-----------------------------------------------------------------------+
  1389	    | long, signed long, long int, signed long int     | long               |
  1390	    +-----------------------------------------------------------------------+
  1391	    | unsigned long, unsigned long int                 | unsigned long      |
  1392	    +-----------------------------------------------------------------------|
> 1393	    | long long, signed long long, long long int,      | long long          |

-- 
0-DAY CI Kernel Test Service
https://01.org/lkp