Re: [PATCH 7/7] dt-bindings: interconnect: qcom: msm8939: Fix example

From: Krzysztof Kozlowski
Date: Mon Jun 10 2024 - 08:57:32 EST


On 09/06/2024 20:21, Adam Skladowski wrote:
> For now example list snoc_mm as children of bimc which is obviously
> not valid, change example and include rest of nocs in it.
>
> Fixes: 462baaf4c628 ("dt-bindings: interconnect: qcom: Fix and separate out MSM8939")
> Signed-off-by: Adam Skladowski <a39.skl@xxxxxxxxx>
> ---
> .../bindings/interconnect/qcom,msm8939.yaml | 22 ++++++++++++-------
> 1 file changed, 14 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/interconnect/qcom,msm8939.yaml b/Documentation/devicetree/bindings/interconnect/qcom,msm8939.yaml
> index fd15ab5014fb..a77e6aa2fbee 100644
> --- a/Documentation/devicetree/bindings/interconnect/qcom,msm8939.yaml
> +++ b/Documentation/devicetree/bindings/interconnect/qcom,msm8939.yaml
> @@ -56,19 +56,25 @@ examples:
> - |
> #include <dt-bindings/clock/qcom,rpmcc.h>
>
> - snoc: interconnect@580000 {
> - compatible = "qcom,msm8939-snoc";
> - reg = <0x00580000 0x14000>;
> - #interconnect-cells = <1>;
> - };
> -
> bimc: interconnect@400000 {
> compatible = "qcom,msm8939-bimc";
> reg = <0x00400000 0x62000>;
> - #interconnect-cells = <1>;
> + #interconnect-cells = <2>;
> + };
> +
> + pcnoc: interconnect@500000 {
> + compatible = "qcom,msm8939-pcnoc";
> + reg = <0x00500000 0x11000>;
> + #interconnect-cells = <2>;
> + };

Don't grow the examples.

It is enough to have one example to validate the schema and show how the
binding is used. If schema covers multiple combinations of devices and
their properties, then more than one example seems reasonable. This is
not the case. All of this is redundant... and redundant information is
not good because as this commit shows it leads to something which people
think is not correct and they find bugs. So just drop the redundant
information.

Keep only one, correct example.

Best regards,
Krzysztof