Received-SPF: pass (google.com: domain of linux-kernel+bounces-177654-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Diederik de Haas <didi.debian@cknow.org>
To: Jani Nikula <jani.nikula@linux.intel.com>,
 Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: 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
Subject:
 Re: [PATCH] docs: dev-tools: checkpatch: Add targets for checkpatch tags
Date: Mon, 13 May 2024 15:45:35 +0200
Message-ID: <10035992.Dr8D0Bp7vt@bagend>
Organization: Connecting Knowledge
In-Reply-To:
 <CAKXUXMzw6_JnPxXfgU2tEU-VkU6E_=ee-V4MUzGX8MQCSXLuNA@mail.gmail.com>
References:
 <20240513102237.112376-1-didi.debian@cknow.org> <87a5kuez97.fsf@intel.com>
 <CAKXUXMzw6_JnPxXfgU2tEU-VkU6E_=ee-V4MUzGX8MQCSXLuNA@mail.gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="nextPart1882286.OJMM5I3xxo";
 micalg="pgp-sha256"; protocol="application/pgp-signature"

--nextPart1882286.OJMM5I3xxo
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset="UTF-8"; protected-headers="v1"
From: Diederik de Haas <didi.debian@cknow.org>
Date: Mon, 13 May 2024 15:45:35 +0200
Message-ID: <10035992.Dr8D0Bp7vt@bagend>
Organization: Connecting Knowledge
MIME-Version: 1.0

On Monday, 13 May 2024 13:46:39 CEST Lukas Bulwahn wrote:
> On Mon, May 13, 2024 at 1:18=E2=80=AFPM Jani Nikula <jani.nikula@linux.in=
tel.com>=20
wrote:
> > On Mon, 13 May 2024, Diederik de Haas <didi.debian@cknow.org> wrote:
> > > Make the tags directly linkable by defining targets for them.
> > >=20
> > > Closes: https://lore.kernel.org/r/8090211.0vHzs8tI1a@bagend/
> > > Signed-off-by: Diederik de Haas <didi.debian@cknow.org>
> > > ---
> > >=20
> > >  Documentation/dev-tools/checkpatch.rst | 216 +++++++++++++++++++++++=
++
> > >  1 file changed, 216 insertions(+)
> > >=20
> > > 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
> > > message types in checkpatch.> >=20
> > >  Allocation style
> > >  ----------------
> > >=20
> > > +  .. _alloc-array-args:
> > > +
> > >=20
> > >    **ALLOC_ARRAY_ARGS**
> >=20
> > 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.

Yeah, makes sense.

Indented boldface letters (as it is now), stands out visually much more the=
n=20
an ``<h4>`` header (tried it with "^ for subsubsections").

Is being able to use URLs/Links like this:
https://docs.kernel.org/dev-tools/checkpatch.html#BAD_FIXES_TAG

considered worth the (visual) trade-off?

> 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.
>=20
> So, please make sure the current --verbose option in checkpatch.pl
> does not break.

It's a bit more challenging for me being (mostly) clueless about Perl.

Cheers,
  Diederik
--nextPart1882286.OJMM5I3xxo
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: This is a digitally signed message part.
Content-Transfer-Encoding: 7Bit

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQT1sUPBYsyGmi4usy/XblvOeH7bbgUCZkIZfwAKCRDXblvOeH7b
blIzAP9EhFqKBYgRIDerE91l8NptluoQXqKx9QvAq7kcZbepUQEAokli6UYhQg8y
U9NYbmo7PCn4oAITKqG5tfuRdYPHLgY=
=KViu
-----END PGP SIGNATURE-----

--nextPart1882286.OJMM5I3xxo--