Received-SPF: pass (google.com: domain of linux-kernel+bounces-177519-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Precedence: bulk
MIME-Version: 1.0
References: <20240513102237.112376-1-didi.debian@cknow.org> <87a5kuez97.fsf@intel.com>
In-Reply-To: <87a5kuez97.fsf@intel.com>
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date: Mon, 13 May 2024 13:46:39 +0200
Message-ID: <CAKXUXMzw6_JnPxXfgU2tEU-VkU6E_=ee-V4MUzGX8MQCSXLuNA@mail.gmail.com>
Subject: Re: [PATCH] docs: dev-tools: checkpatch: Add targets for checkpatch tags
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Diederik de Haas <didi.debian@cknow.org>, Dwaipayan Ray <dwaipayanray1@gmail.com>, 
	Joe Perches <joe@perches.com>, Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org, 
	linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Mon, May 13, 2024 at 1:18=E2=80=AFPM Jani Nikula <jani.nikula@linux.inte=
l.com> wrote:
>
> On Mon, 13 May 2024, Diederik de Haas <didi.debian@cknow.org> wrote:
> > Make the tags directly linkable by defining targets for them.
> >
> > Closes: https://lore.kernel.org/r/8090211.0vHzs8tI1a@bagend/
> > Signed-off-by: Diederik de Haas <didi.debian@cknow.org>
> > ---
> >  Documentation/dev-tools/checkpatch.rst | 216 +++++++++++++++++++++++++
> >  1 file changed, 216 insertions(+)
> >
> > diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev=
-tools/checkpatch.rst
> > index 127968995847..6499e29c3a19 100644
> > --- a/Documentation/dev-tools/checkpatch.rst
> > +++ b/Documentation/dev-tools/checkpatch.rst
> > @@ -242,6 +242,8 @@ This section contains a description of all the mess=
age types in checkpatch.
> >  Allocation style
> >  ----------------
> >
> > +  .. _alloc-array-args:
> > +
> >    **ALLOC_ARRAY_ARGS**
>
> Alternatively, you could just convert the definition lists into section
> titles to make them implicit hyperlink targets. The rst stays cleaner
> and there's no manual updating.
>

Agree with Jani. It is important to check that the verbose option of
the checkpatch still works. The script actually parses the
documentation and then shows the relevant parts as verbose output to
the user. It currently relies on the specific format, but it is not
difficult to change that to use a different pattern, see sub load_docs
in checkpatch.pl.

So, please make sure the current --verbose option in checkpatch.pl
does not break.

Thanks,

Lukas