dt-bindings: Add a writing DT schemas how-to and annotated example
authorRob Herring <robh@kernel.org>
Fri, 29 Jun 2018 14:19:52 +0000 (08:19 -0600)
committerRob Herring <robh@kernel.org>
Thu, 13 Dec 2018 15:41:49 +0000 (09:41 -0600)
commit00ce8a800060c80c6d0c895fad10cacb03277fcc
treed79a86ad1aeb193608a1c3bdc5153d4275572367
parent4f0e3a57d6eb727c54249542c509e0b7aa122465
dt-bindings: Add a writing DT schemas how-to and annotated example

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>
Documentation/devicetree/bindings/example-schema.yaml [new file with mode: 0644]
Documentation/devicetree/writing-schema.md [new file with mode: 0644]