michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/dts/binding-template.yaml

11 lines
297 B
YAML
Raw Permalink Normal View History

doc: devicetree: overhaul bindings guide The binding-template.yaml file has grown organically into something that's out of control. It makes too many 'see above' and 'see below' references to be read comfortably, and we can't cross reference from YAML. There are also many example DTS and YAML fragments scattered about in comments, which cannot be syntax highlighted properly. Fix that by overhauling the documentation into bindings.rst in the DT guide. This will let us link to individual sections when answering questions, allows us to cross-reference and use '.. code-block::', etc. A couple of things need to go to other pages. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-04-16 09:08:55 +02:00
# The contents of this file have been moved to the documentation.
scripts: dts: Simplify and improve 'compatible' matching Instead of properties: compatible: constraint: "foo" , just have compatible: "foo" at the top level of the binding. For backwards compatibility, the old 'properties: compatible: ...' form is still accepted for now, and is treated the same as a single-element 'compatible:'. The old syntax was inspired by dt-schema (though it isn't dt-schema-compatible), which is in turn a thin wrapper around json-schema (the idea is to transform .dts files into YAML and then verify them). Maybe the idea was to gradually switch the syntax over to dt-schema and then be able to use unmodified dt-schema bindings, but dt-schema is really a different kind of tool (a completely standalone linter), and works very differently from our stuff (see schemas/dt-core.yaml in the dt-schema repo to get an idea of just how differently). Better to keep it simple. This commit also piggybacks some clarifications to the binding template re. '#cells:'. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-19 20:32:25 +02:00
#
doc: devicetree: overhaul bindings guide The binding-template.yaml file has grown organically into something that's out of control. It makes too many 'see above' and 'see below' references to be read comfortably, and we can't cross reference from YAML. There are also many example DTS and YAML fragments scattered about in comments, which cannot be syntax highlighted properly. Fix that by overhauling the documentation into bindings.rst in the DT guide. This will let us link to individual sections when answering questions, allows us to cross-reference and use '.. code-block::', etc. A couple of things need to go to other pages. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-04-16 09:08:55 +02:00
# See this page in the HTML documentation:
scripts: dts: Simplify and improve 'compatible' matching Instead of properties: compatible: constraint: "foo" , just have compatible: "foo" at the top level of the binding. For backwards compatibility, the old 'properties: compatible: ...' form is still accepted for now, and is treated the same as a single-element 'compatible:'. The old syntax was inspired by dt-schema (though it isn't dt-schema-compatible), which is in turn a thin wrapper around json-schema (the idea is to transform .dts files into YAML and then verify them). Maybe the idea was to gradually switch the syntax over to dt-schema and then be able to use unmodified dt-schema bindings, but dt-schema is really a different kind of tool (a completely standalone linter), and works very differently from our stuff (see schemas/dt-core.yaml in the dt-schema repo to get an idea of just how differently). Better to keep it simple. This commit also piggybacks some clarifications to the binding template re. '#cells:'. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-19 20:32:25 +02:00
#
doc: devicetree: overhaul bindings guide The binding-template.yaml file has grown organically into something that's out of control. It makes too many 'see above' and 'see below' references to be read comfortably, and we can't cross reference from YAML. There are also many example DTS and YAML fragments scattered about in comments, which cannot be syntax highlighted properly. Fix that by overhauling the documentation into bindings.rst in the DT guide. This will let us link to individual sections when answering questions, allows us to cross-reference and use '.. code-block::', etc. A couple of things need to go to other pages. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-04-16 09:08:55 +02:00
# User and Developer Guides >
# Devicetree Guide >
# Devicetree bindings
scripts: dts: Simplify and improve 'compatible' matching Instead of properties: compatible: constraint: "foo" , just have compatible: "foo" at the top level of the binding. For backwards compatibility, the old 'properties: compatible: ...' form is still accepted for now, and is treated the same as a single-element 'compatible:'. The old syntax was inspired by dt-schema (though it isn't dt-schema-compatible), which is in turn a thin wrapper around json-schema (the idea is to transform .dts files into YAML and then verify them). Maybe the idea was to gradually switch the syntax over to dt-schema and then be able to use unmodified dt-schema bindings, but dt-schema is really a different kind of tool (a completely standalone linter), and works very differently from our stuff (see schemas/dt-core.yaml in the dt-schema repo to get an idea of just how differently). Better to keep it simple. This commit also piggybacks some clarifications to the binding template re. '#cells:'. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-19 20:32:25 +02:00
#
doc: devicetree: overhaul bindings guide The binding-template.yaml file has grown organically into something that's out of control. It makes too many 'see above' and 'see below' references to be read comfortably, and we can't cross reference from YAML. There are also many example DTS and YAML fragments scattered about in comments, which cannot be syntax highlighted properly. Fix that by overhauling the documentation into bindings.rst in the DT guide. This will let us link to individual sections when answering questions, allows us to cross-reference and use '.. code-block::', etc. A couple of things need to go to other pages. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-04-16 09:08:55 +02:00
# For the latest version:
# https://docs.zephyrproject.org/latest/guides/dts/bindings.html
Copy permalink