mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-10-14 04:26:45 +00:00
Code Issues Releases Wiki Activity

docs: dt: writing-schema: Include the example schema in the doc build

Browse source 
The example-schema.yaml file serves as documentation, so let's include it
from writing-schema.rst.

Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/20210325164713.1296407-4-robh@kernel.org
This commit is contained in:
Rob Herring 2021-03-25 10:47:08 -06:00
parent 0d45f83351
commit 9be21f7358
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Documentation/devicetree/writing-schema.rst
View file

@ -8,6 +8,8 @@ written in a JSON compatible subset of YAML. YAML is used instead of JSON as it
is considered more human readable and has some advantages such as allowing is considered more human readable and has some advantages such as allowing
comments (Prefixed with '#'). comments (Prefixed with '#').
Also see :ref:`example-schema`.
Schema Contents Schema Contents
--------------- ---------------
@ -170,3 +172,12 @@ json-schema Resources
`JSON-Schema Specifications <http://json-schema.org/>`_ `JSON-Schema Specifications <http://json-schema.org/>`_
`Using JSON Schema Book <http://usingjsonschema.com/>`_ `Using JSON Schema Book <http://usingjsonschema.com/>`_
.. _example-schema:
Annotated Example Schema
------------------------
Also available as a separate file: :download:`example-schema.yaml`
.. literalinclude:: example-schema.yaml