From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@kernel.org>
X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on
	aws-us-west-2-korg-lkml-1.web.codeaurora.org
X-Spam-Level: 
X-Spam-Status: No, score=-8.8 required=3.0 tests=BAYES_00,
	HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,
	SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0
Received: from mail.kernel.org (mail.kernel.org [198.145.29.99])
	by smtp.lore.kernel.org (Postfix) with ESMTP id DA1DBC433DB
	for <linux-kernel@archiver.kernel.org>; Fri, 19 Feb 2021 17:56:30 +0000 (UTC)
Received: from vger.kernel.org (vger.kernel.org [23.128.96.18])
	by mail.kernel.org (Postfix) with ESMTP id ABA2664E86
	for <linux-kernel@archiver.kernel.org>; Fri, 19 Feb 2021 17:56:30 +0000 (UTC)
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S229925AbhBSR43 (ORCPT <rfc822;linux-kernel@archiver.kernel.org>);
        Fri, 19 Feb 2021 12:56:29 -0500
Received: from smtprelay0177.hostedemail.com ([216.40.44.177]:60272 "EHLO
        smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL)
        by vger.kernel.org with ESMTP id S229726AbhBSR4Z (ORCPT
        <rfc822;linux-kernel@vger.kernel.org>);
        Fri, 19 Feb 2021 12:56:25 -0500
Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60])
        by smtprelay01.hostedemail.com (Postfix) with ESMTP id 75D58100E7B40;
        Fri, 19 Feb 2021 17:55:42 +0000 (UTC)
X-Session-Marker: 6A6F6540706572636865732E636F6D
X-HE-Tag: tail44_090e71c2765f
X-Filterd-Recvd-Size: 2427
Received: from [192.168.1.159] (unknown [47.151.137.21])
        (Authenticated sender: joe@perches.com)
        by omf16.hostedemail.com (Postfix) with ESMTPA;
        Fri, 19 Feb 2021 17:55:41 +0000 (UTC)
Message-ID: <02966e73a288d49372746d61547084e13a2fac29.camel@perches.com>
Subject: Re: [PATCH v4 2/2] docs: add documentation for checkpatch
From:   Joe Perches <joe@perches.com>
To:     Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc:     lukas.bulwahn@gmail.com,
        linux-kernel-mentees@lists.linuxfoundation.org,
        linux-kernel@vger.kernel.org
Date:   Fri, 19 Feb 2021 09:55:40 -0800
In-Reply-To: <20210217165434.69298-3-dwaipayanray1@gmail.com>
References: <20210217165434.69298-1-dwaipayanray1@gmail.com>
         <20210217165434.69298-3-dwaipayanray1@gmail.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.38.1-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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... ;)

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