summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/example-schema.yaml
AgeCommit message (Collapse)Author
2020-05-03dt-bindings: Remove cases of 'allOf' containing a '$ref'Rob Herring
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 <robh@kernel.org> Acked-by: Maxime Ripard <mripard@kernel.org> Acked-by: Lee Jones <lee.jones@linaro.org> Acked-By: Vinod Koul <vkoul@kernel.org> Acked-by: Mark Brown <broonie@kernel.org> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Acked-by: Wolfram Sang <wsa@the-dreams.de> # for I2C Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for-iio Reviewed-by: Stephen Boyd <sboyd@kernel.org> # clock Signed-off-by: Rob Herring <robh@kernel.org>
2020-02-26dt-bindings: example-schema: Drop double quotes around URLsGeert Uytterhoeven
It is no longer needed to wrap URLs in double quotes. Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> Signed-off-by: Rob Herring <robh@kernel.org>
2019-11-11dt-bindings: example-schema: Standard unit should be microvolt not microvoltsRob Herring
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 <robh@kernel.org>
2019-10-25dt-bindings: example-schema: Add some additional examples and commentaryRob Herring
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 <robh@kernel.org>
2019-09-06dt-bindings: Correct spelling in example schemaSimon Horman
Correct spelling of "identifier". Signed-off-by: Simon Horman <horms+renesas@verge.net.au> Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be> Signed-off-by: Rob Herring <robh@kernel.org>
2018-12-13dt-bindings: Add a writing DT schemas how-to and annotated exampleRob Herring
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 <mark.rutland@arm.com> Cc: devicetree@vger.kernel.org Signed-off-by: Rob Herring <robh@kernel.org>