path: root/Documentation/devicetree/writing-schema.rst (follow)
AgeCommit message (Collapse)AuthorFilesLines
2020-01-23dt-bindings: Be explicit about installing depsLinus Walleij1-1/+7
Make sure the reader of the document is aware that some active installation of the libyaml development package is required and provide two examples. Signed-off-by: Linus Walleij <linus.walleij@linaro.org> Signed-off-by: Rob Herring <robh@kernel.org>
2019-11-14dt-bindings: Improve validation build error handlingRob Herring1-2/+4
Schema errors can cause make to exit before useful information is printed. This leaves developers wondering what's wrong. It can be overcome passing '-k' to make, but that's not an obvious solution. There's 2 scenarios where this happens. When using DT_SCHEMA_FILES to validate with a single schema, any error in the schema results in processed-schema.yaml being empty causing a make error. The result is the specific errors in the schema are never shown because processed-schema.yaml is the first target built. Simply making processed-schema.yaml last in extra-y ensures the full schema validation with detailed error messages happen first. The 2nd problem is while schema errors are ignored for processed-schema.yaml, full validation of the schema still runs in parallel and any schema validation errors will still stop the build when running validation of dts files. The fix is to not add the schema examples to extra-y in this case. This means 'dtbs_check' is no longer a superset of 'dt_binding_check'. Update the documentation to make this clear. Cc: Masahiro Yamada <yamada.masahiro@socionext.com> Tested-by: Jeffrey Hugo <jhugo@codeaurora.org> Signed-off-by: Rob Herring <robh@kernel.org>
2019-10-25dt: writing-schema: Add a note about tools PATH setupRob Herring1-0/+3
Users without an existing python install may not have their PATH setup for pip installed python programs already. Add a note about having the DT validation programs in the PATH. Reported-by: Robert Jones <rjones@gateworks.com> Signed-off-by: Rob Herring <robh@kernel.org>
2019-08-13devicetree: Expose dtbs_check and dt_binding_check some moreStephen Boyd1-0/+1
It wasn't obvious that this was a command to run based on 'make help', so add it to the top-level help for devicetree builds. Also, add an example to the documentation to show that db_binding_check can be run with DT_SCHEMA_FILES= to only check one schema file instead of all of them. Cc: Masahiro Yamada <yamada.masahiro@socionext.com> Cc: <linux-kbuild@vger.kernel.org> Cc: <devicetree@vger.kernel.org> Cc: <linux-doc@vger.kernel.org> Signed-off-by: Stephen Boyd <sboyd@kernel.org> [robh: fix-up due to .md to .rst conversion] Signed-off-by: Rob Herring <robh@kernel.org>
2019-08-13docs: writing-schema.md: convert from markdown to ReSTMauro Carvalho Chehab1-0/+153
The documentation standard is ReST and not markdown. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Rob Herring <robh@kernel.org>