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

Krzysztof Kozlowski krzysztof.kozlowski at linaro.org
Sat Dec 2 05:04:32 PST 2023


On 01/12/2023 17:46, Conor Dooley wrote:
> 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@meer.lwn.net/
> 

Sure, indeed it's better for plain-text readers.

Best regards,
Krzysztof




More information about the linux-arm-kernel mailing list