lkml.org 
[lkml]   [2023]   [Dec]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [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@ti.com>
    > cc: Andrew Lunn <andrew@lunn.ch>
    > Cc: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
    > Cc: Arnd Bergmann <arnd@arndb.de>
    > Cc: Bjorn Andersson <andersson@kernel.org>
    > Cc: Chen-Yu Tsai <wens@kernel.org>
    > Cc: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
    > Cc: Jonathan Corbet <corbet@lwn.net>
    > Cc: Matthias Brugger <matthias.bgg@gmail.com>
    > Cc: Michal Simek <michal.simek@amd.com>
    > Cc: Neil Armstrong <neil.armstrong@linaro.org>
    > Cc: Nishanth Menon <nm@ti.com>
    > Cc: Olof Johansson <olof@lixom.net>
    > Cc: Rafał Miłecki <zajec5@gmail.com>
    > Acked-by: Neil Armstrong <neil.armstrong@linaro.org>
    > Acked-by: Heiko Stuebner <heiko@sntech.de>
    > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
    > Acked-by: Konrad Dybcio <konradybcio@kernel.org>
    > Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
    > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.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@lists.infradead.org
    > Cc: linux-mediatek@lists.infradead.org
    > Cc: linux-samsung-soc@vger.kernel.org
    > Cc: linux-amlogic@lists.infradead.org
    > Cc: linux-arm-kernel@lists.infradead.org
    > Cc: linux-arm-msm@vger.kernel.org
    > Cc: workflows@vger.kernel.org
    > Cc: linux-doc@vger.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

    \
     
     \ /
      Last update: 2023-12-07 18:59    [W:8.158 / U:0.036 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site