linux.git/Documentation/devicetree/bindings/example-schema.yaml, branch v5.10.258

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

dt-bindings: Remove cases of 'allOf' containing a '$ref'

2020-05-03T16:10:41+00:00

json-schema versions draft7 and earlier have a weird behavior in that
any keywords combined with a '$ref' are ignored (silently). The correct
form was to put a '$ref' under an 'allOf'. This behavior is now changed
in the 2019-09 json-schema spec and '$ref' can be mixed with other
keywords. The json-schema library doesn't yet support this, but the
tooling now does a fixup for this and either way works.

This has been a constant source of review comments, so let's change this
treewide so everyone copies the simpler syntax.

Scripted with ruamel.yaml with some manual fixups. Some minor whitespace
changes from the script.

Signed-off-by: Rob Herring 
Acked-by: Maxime Ripard 
Acked-by: Lee Jones 
Acked-By: Vinod Koul 
Acked-by: Mark Brown 
Acked-by: Alexandre Belloni 
Acked-by: Wolfram Sang  # for I2C
Reviewed-by: Linus Walleij 
Acked-by: Jonathan Cameron  #for-iio
Reviewed-by: Stephen Boyd  # clock
Signed-off-by: Rob Herring

dt-bindings: example-schema: Drop double quotes around URLs

2020-02-26T15:35:57+00:00

It is no longer needed to wrap URLs in double quotes.

Signed-off-by: Geert Uytterhoeven 
Signed-off-by: Rob Herring

dt-bindings: example-schema: Standard unit should be microvolt not microvolts

2019-11-11T17:21:58+00:00

Even the DT maintainer gets confused. The schema in dt-schema was wrong
too, so this was passing validation until trying to add some common
incorrect patterns to check.

Fixes: 58fbe999ff40 ("dt-bindings: example-schema: Add some additional examples and commentary")
Signed-off-by: Rob Herring

dt-bindings: example-schema: Add some additional examples and commentary

2019-10-25T14:14:21+00:00

Add examples for properties with standard units, child nodes,
dependencies, and if/then schema. Also, make some minor updates based on
common questions and review issues.

Signed-off-by: Rob Herring

dt-bindings: Correct spelling in example schema

2019-09-06T14:29:12+00:00

Correct spelling of "identifier".

Signed-off-by: Simon Horman 
Reviewed-by: Geert Uytterhoeven 
Signed-off-by: Rob Herring

dt-bindings: Add a writing DT schemas how-to and annotated example

2018-12-13T15:41:49+00:00

Add a how-to doc on writing DT schema documentation. This gives a
description of each section and details on how to validate the DT schema
file. The DT schema are written using json-schema vocabulary in a YAML
encoded document. Using jsonschema gives us access to existing tooling.
A YAML encoding gives us something easy to edit. The example is
annotated to help explain what each section does.

This example is just the tip of the iceberg, but is it the part most
developers writing bindings will interact with. Backing all this up
are meta-schema (to validate the binding schemas), some DT core schema,
YAML encoded DT output with dtc, and a small number of python scripts to
run validation.

Cc: Mark Rutland 
Cc: devicetree@vger.kernel.org
Signed-off-by: Rob Herring