linux-kernel - Re: [PATCH v4] docs: dt-bindings: add DTS Coding Style document

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 7 Dec 2023 11:58:20 -0600
From:   Rob Herring <robh@...nel.org>
To:     Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
Cc:     Nishanth Menon <nm@...com>, linux-mediatek@...ts.infradead.org,
        Dmitry Baryshkov <dmitry.baryshkov@...aro.org>,
        Arnd Bergmann <arnd@...db.de>, Olof Johansson <olof@...om.net>,
        linux-arm-msm@...r.kernel.org, linux-doc@...r.kernel.org,
        Andrew Davis <afd@...com>, Andrew Lunn <andrew@...n.ch>,
        linux-rockchip@...ts.infradead.org,
        Michal Simek <michal.simek@....com>,
        Neil Armstrong <neil.armstrong@...aro.org>,
        Jonathan Corbet <corbet@....net>,
        Konrad Dybcio <konradybcio@...nel.org>,
        Chen-Yu Tsai <wens@...nel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
        linux-amlogic@...ts.infradead.org,
        Bjorn Andersson <andersson@...nel.org>,
        Rafał Miłecki <zajec5@...il.com>,
        linux-kernel@...r.kernel.org,
        Geert Uytterhoeven <geert+renesas@...der.be>,
        workflows@...r.kernel.org, Rob Herring <robh+dt@...nel.org>,
        Laurent Pinchart <laurent.pinchart@...asonboard.com>,
        Matthias Brugger <matthias.bgg@...il.com>,
        devicetree@...r.kernel.org, Heiko Stuebner <heiko@...ech.de>,
        AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@...labora.com>,
        Conor Dooley <conor+dt@...nel.org>,
        linux-arm-kernel@...ts.infradead.org,
        linux-samsung-soc@...r.kernel.org
Subject: Re: [PATCH v4] docs: dt-bindings: add DTS Coding Style document


On Sun, 03 Dec 2023 18:46:22 +0100, Krzysztof Kozlowski wrote:
> Document preferred coding style for Devicetree sources (DTS and DTSI),
> to bring consistency among all (sub)architectures and ease in reviews.
> 
> Cc: Andrew Davis <afd@...com>
> cc: Andrew Lunn <andrew@...n.ch>
> Cc: AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>
> Cc: Arnd Bergmann <arnd@...db.de>
> Cc: Bjorn Andersson <andersson@...nel.org>
> Cc: Chen-Yu Tsai <wens@...nel.org>
> Cc: Dmitry Baryshkov <dmitry.baryshkov@...aro.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Matthias Brugger <matthias.bgg@...il.com>
> Cc: Michal Simek <michal.simek@....com>
> Cc: Neil Armstrong <neil.armstrong@...aro.org>
> Cc: Nishanth Menon <nm@...com>
> Cc: Olof Johansson <olof@...om.net>
> Cc: Rafał Miłecki <zajec5@...il.com>
> Acked-by: Neil Armstrong <neil.armstrong@...aro.org>
> Acked-by: Heiko Stuebner <heiko@...ech.de>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@...asonboard.com>
> Acked-by: Konrad Dybcio <konradybcio@...nel.org>
> Reviewed-by: Geert Uytterhoeven <geert+renesas@...der.be>
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
> 
> ---
> 
> Merging idea: Rob/DT bindings
> 
> Changes in v4
> =============
> 1. Drop label at the top (Jon)
> 2. Grammar fixes (Laurent, Dragan)
> 3. "Unless a bus defines differently, unit addresses shall ..." (Rob)
> 4. Use hex in example of dma-controller (Andrew)
> 5. Example: soc@ -> soc@0
> 6. Reverse points 2 and 3 in "Indentation" (Andrew)
> 7. Use full path to coding style doc (Conor)
> 
> Changes in v3
> =============
> 1. should->shall (Angelo)
> 2. Comments // -> /* (Angelo, Michal)
> 3. Use imaginary example in "Order of Properties in Device Node"
>    (Angelo)
> 4. Added paragraphs for three sections with justifications of chosen
>    style.
> 5. Allow two style of ordering overrides in board DTS: alphabetically or
>    by order of DTSI (Rob).
> 6. I did not incorporate feedback about, due to lack of consensus and my
>    disagreement:
>    a. SoM being DTS without DTSI in "Organizing DTSI and DTS"
> 
> Changes in v2
> =============
> 1. Hopefully incorporate entire feedback from comments:
> a. Fix \ { => / { (Rob)
> b. Name: dts-coding-style (Rob)
> c. Exceptions for ordering nodes by name for Renesas and pinctrl (Geert,
>    Konrad)
> d. Ordering properties by common/vendor (Rob)
> e. Array entries in <> (Rob)
> 
> 2. New chapter: Organizing DTSI and DTS
> 
> 3. Several grammar fixes (missing articles)
> 
> Cc: linux-rockchip@...ts.infradead.org
> Cc: linux-mediatek@...ts.infradead.org
> Cc: linux-samsung-soc@...r.kernel.org
> Cc: linux-amlogic@...ts.infradead.org
> Cc: linux-arm-kernel@...ts.infradead.org
> Cc: linux-arm-msm@...r.kernel.org
> Cc: workflows@...r.kernel.org
> Cc: linux-doc@...r.kernel.org
> ---
>  .../devicetree/bindings/dts-coding-style.rst  | 196 ++++++++++++++++++
>  Documentation/devicetree/bindings/index.rst   |   1 +
>  2 files changed, 197 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/dts-coding-style.rst
> 

I added the quotes as discussed and applied, thanks!

Rob