linux-toradex.git/Documentation/devicetree/bindings/example-schema.yaml, branch v6.7

dt-bindings: example-schema: don't use enum as fallback, explain clock-names

2023-06-15T17:25:44+00:00

Compatibles with multiple entries should have usually only one fallback
compatible thus enum followed by enum is not a common case.  Use 'const'
as second compatible to show the recommended approach.

Explain also when clock-names are not really necessary.

Signed-off-by: Krzysztof Kozlowski 
Link: https://lore.kernel.org/r/20230612092611.12385-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring

dt-bindings: Add missing (unevaluated|additional)Properties on child node schemas

2023-04-05T20:38:38+00:00

Just as unevaluatedProperties or additionalProperties are required at
the top level of schemas, they should (and will) also be required for
child node schemas. That ensures only documented properties are
present.

Add unevaluatedProperties or additionalProperties as appropriate, and
then add any missing properties flagged by the addition.

Acked-by: Sebastian Reichel 
Acked-by: Guenter Roeck 
Acked-by: Greg Kroah-Hartman 
Acked-by: Mark Brown 
Acked-by: Lee Jones 
Reviewed-by: Krzysztof Kozlowski 
Link: https://lore.kernel.org/r/20230124230228.372305-1-robh@kernel.org
Signed-off-by: Rob Herring

dt-bindings: drop redundant part of title (manual)

2022-12-16T18:51:43+00:00

The Devicetree bindings document does not have to say in the title that
it is a "Devicetree binding" or a "schema", but instead just describe
the hardware.

Manual updates to various binding titles, including capitalizing them.

Signed-off-by: Krzysztof Kozlowski 
Acked-by: Alexandre Belloni 
Reviewed-by: Jonathan Cameron 
Acked-by: Ulf Hansson  # MMC
Acked-by: Stephen Boyd  # clk
Acked-by: Dmitry Torokhov  # input
Acked-by: Mark Brown 
Acked-by: Viresh Kumar  # opp
Link: https://lore.kernel.org/r/20221216163815.522628-10-krzysztof.kozlowski@linaro.org
[robh: add trivial-devices.yaml and net/can/microchip,mcp251xfd.yaml]
Signed-off-by: Rob Herring

docs: dt: writing-schema: mention coding style

2022-04-05T00:55:03+00:00

Mention the usage of YAML coding style.  Describe explicitly that
four-space indentation in DTS examples is preferred, because:
1. The YAML's default two-space indentation for DTS code makes it
   significantly less readable.
2. Linux coding style tabs would introduce inconsistency (entire file is
   indented with spaces).
3. On the other hand, eight spaces would not align with example's
   opening '  - |' part.  Four spaces makes the code nicely aligned with
   it.

Signed-off-by: Krzysztof Kozlowski 
Signed-off-by: Rob Herring 
Link: https://lore.kernel.org/r/20220403081849.8051-2-krzysztof.kozlowski@linaro.org

dt-bindings: example: Extend with typical case (int-array and disallowed prop)

2022-02-24T15:55:56+00:00

Extend the example with:
 - an array where each element has constraints (min/max value),
 - property not allowed in case of different compatible.

Signed-off-by: Krzysztof Kozlowski 
Signed-off-by: Rob Herring 
Link: https://lore.kernel.org/r/20220223073547.8746-2-krzysztof.kozlowski@canonical.com

docs: dt: Fix a few grammar nits in the binding/schema docs

2021-10-04T18:55:37+00:00

Add missing hyphens and reword one sentence for clarity.

Signed-off-by: Simon Glass 
Reviewed-by: Randy Dunlap 
Link: https://lore.kernel.org/r/20211003124936.1.Idc7beddc77250bca0cfb5912b56be719d9073bc4@changeid
Signed-off-by: Rob Herring

dt-bindings: Drop redundant minItems/maxItems

2021-06-21T19:56:46+00:00

If a property has an 'items' list, then a 'minItems' or 'maxItems' with the
same size as the list is redundant and can be dropped. Note that is DT
schema specific behavior and not standard json-schema behavior. The tooling
will fixup the final schema adding any unspecified minItems/maxItems.

This condition is partially checked with the meta-schema already, but
only if both 'minItems' and 'maxItems' are equal to the 'items' length.
An improved meta-schema is pending.

Cc: Jens Axboe 
Cc: Stephen Boyd 
Cc: Herbert Xu 
Cc: "David S. Miller" 
Cc: David Airlie 
Cc: Daniel Vetter 
Cc: Bartosz Golaszewski 
Cc: Kamal Dasu 
Cc: Lars-Peter Clausen 
Cc: Thomas Gleixner 
Cc: Marc Zyngier 
Cc: Joerg Roedel 
Cc: Mauro Carvalho Chehab 
Cc: Krzysztof Kozlowski 
Cc: Jakub Kicinski 
Cc: Wolfgang Grandegger 
Cc: Andrew Lunn 
Cc: Vivien Didelot 
Cc: Vladimir Oltean 
Cc: Bjorn Helgaas 
Cc: Kishon Vijay Abraham I 
Cc: Linus Walleij 
Cc: "Uwe Kleine-König" 
Cc: Lee Jones 
Cc: Ohad Ben-Cohen 
Cc: Mathieu Poirier 
Cc: Paul Walmsley 
Cc: Palmer Dabbelt 
Cc: Albert Ou 
Cc: Alessandro Zummo 
Cc: Alexandre Belloni 
Cc: Zhang Rui 
Cc: Daniel Lezcano 
Cc: Wim Van Sebroeck 
Cc: Guenter Roeck 
Signed-off-by: Rob Herring 
Acked-by: Marc Kleine-Budde 
Acked-by: Ulf Hansson  # for MMC
Acked-by: Jassi Brar 
Acked-By: Vinod Koul 
Reviewed-by: Greg Kroah-Hartman 
Reviewed-by: Arnaud Pouliquen 
Acked-by: Mark Brown 
Acked-by: Philipp Zabel 
Acked-by: Wolfram Sang  # for I2C
Acked-by: Jonathan Cameron 
Link: https://lore.kernel.org/r/20210615191543.1043414-1-robh@kernel.org

dt-bindings: example: Grammar improvements

2020-09-29T20:32:53+00:00

Improve grammar in recently added sentences:
  - Drop superfluous "be" in front of "have",
  - Add missing articles.

Fixes: 73f76a41c4ed7def ("dt-bindings: example: Extend based on practice")
Reviewed-by: Krzysztof Kozlowski 
Signed-off-by: Geert Uytterhoeven 
Link: https://lore.kernel.org/r/20200925111429.3146-1-geert+renesas@glider.be
Signed-off-by: Rob Herring

dt-bindings: example: Extend based on practice

2020-09-15T22:42:11+00:00

Extend the example schema with common rules which seems to be not that
obvious:
1. Expecting arrays of phandles to be always ordered, regardless if
   "xxx-names" is provided (e.g. clocks),
2. Add example of altering a property based on presence of other
   property,
3. Document usage of unevaluatedProperties.

Signed-off-by: Krzysztof Kozlowski 
Link: https://lore.kernel.org/r/20200910184706.9677-1-krzk@kernel.org
Signed-off-by: Rob Herring

dt-bindings: Whitespace clean-ups in schema files

2020-08-14T14:55:58+00:00

Clean-up incorrect indentation, extra spaces, long lines, and missing
EOF newline in schema files. Most of the clean-ups are for list
indentation which should always be 2 spaces more than the preceding
keyword.

Found with yamllint (which I plan to integrate into the checks).

Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-clk@vger.kernel.org
Cc: dri-devel@lists.freedesktop.org
Cc: linux-spi@vger.kernel.org
Cc: linux-gpio@vger.kernel.org
Cc: linux-remoteproc@vger.kernel.org
Cc: linux-hwmon@vger.kernel.org
Cc: linux-i2c@vger.kernel.org
Cc: linux-fbdev@vger.kernel.org
Cc: linux-iio@vger.kernel.org
Cc: linux-input@vger.kernel.org
Cc: linux-pm@vger.kernel.org
Cc: linux-media@vger.kernel.org
Cc: alsa-devel@alsa-project.org
Cc: linux-mmc@vger.kernel.org
Cc: linux-mtd@lists.infradead.org
Cc: netdev@vger.kernel.org
Cc: linux-rtc@vger.kernel.org
Cc: linux-serial@vger.kernel.org
Cc: linux-usb@vger.kernel.org
Acked-by: Sam Ravnborg 
Signed-off-by: Rob Herring