From: Conor Dooley <conor.dooley@microchip.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: <soc@kernel.org>, <conor@kernel.org>,
<devicetree@vger.kernel.org>, <krzysztof.kozlowski+dt@linaro.org>,
<linux-arm-kernel@lists.infradead.org>,
<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<linux-riscv@lists.infradead.org>, <olof@lixom.net>,
<palmer@dabbelt.com>, <robh+dt@kernel.org>, <arnd@arndb.de>
Subject: Re: [PATCH v2] Documentation/process: add soc maintainer handbook
Date: Tue, 30 May 2023 14:12:07 +0100 [thread overview]
Message-ID: <20230530-enviable-poise-183119e695bf@wendy> (raw)
In-Reply-To: <87bki23rbx.fsf@meer.lwn.net>
[-- Attachment #1.1: Type: text/plain, Size: 1379 bytes --]
On Tue, May 30, 2023 at 07:02:26AM -0600, Jonathan Corbet wrote:
> Conor Dooley <conor.dooley@microchip.com> writes:
> > diff --git a/Documentation/devicetree/bindings/ABI.rst b/Documentation/devicetree/bindings/ABI.rst
> > index a885713cf184..93ec82f78ae5 100644
> > --- a/Documentation/devicetree/bindings/ABI.rst
> > +++ b/Documentation/devicetree/bindings/ABI.rst
> > @@ -1,5 +1,7 @@
> > .. SPDX-License-Identifier: GPL-2.0
> >
> > +.. _devicetree-abi:
>
> Somehow we've developed this habit of putting labels at the top of each
> file; I really think that they just add clutter and are best left out.
> Without the label, this reference:
>
> > +Perhaps one of the most important things to highlight is that dt-bindings
> > +document the ABI between the devicetree and the kernel. Please see
> > +:ref:`devicetree-abi` more information on the ABI.
>
> ...can just be written as "Please see
> Documentation/devicetree/bindings/ABI.rst". The cross-reference link
> will be generated as expected, and readers of the plain-text docs don't
> have to go grepping to find the reference.
Sure. As someone who does read these things in their editor that sounds
preferable to me. I didn't know that I could do that, as the whole
"building the docs" thing is new to me ;)
I'll wait a bit before resubmitting for obvious reasons.
Cheers,
Conor.
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
[-- Attachment #2: Type: text/plain, Size: 176 bytes --]
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2023-05-30 13:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-30 12:49 [PATCH v2] Documentation/process: add soc maintainer handbook Conor Dooley
2023-05-30 13:02 ` Jonathan Corbet
2023-05-30 13:12 ` Conor Dooley [this message]
2023-05-30 13:14 ` Krzysztof Kozlowski
2023-05-30 15:28 ` Randy Dunlap
2023-05-30 22:26 ` Conor Dooley
2023-05-31 6:30 ` Bagas Sanjaya
2023-05-31 6:51 ` Krzysztof Kozlowski
2023-05-31 12:22 ` Bagas Sanjaya
2023-05-31 9:41 ` Conor Dooley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230530-enviable-poise-183119e695bf@wendy \
--to=conor.dooley@microchip.com \
--cc=arnd@arndb.de \
--cc=conor@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=olof@lixom.net \
--cc=palmer@dabbelt.com \
--cc=robh+dt@kernel.org \
--cc=soc@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox