Re: [PATCH v3] docs: dt-bindings: add DTS Coding Style document

From: Conor Dooley
Date: Fri Dec 01 2023 - 11:46:24 EST


On Sat, Nov 25, 2023 at 07:44:22PM +0100, Krzysztof Kozlowski wrote:
> +Indentation
> +-----------
> +
> +1. Use indentation according to :ref:`codingstyle`.

One thing Jonathan mentioned before to me was to drop this :ref: stuff.
| > +: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.
https://lore.kernel.org/all/87bki23rbx.fsf@xxxxxxxxxxxx/

Apparently the doc generation scripting can automagically do the right
thing here:
https://docs.kernel.org/process/maintainer-soc.html#devicetree-abi-stability

Cheers,
Conor.

Attachment: signature.asc
Description: PGP signature