|author||Rob Herring <email@example.com>||2019-11-13 09:46:19 -0600|
|committer||Rob Herring <firstname.lastname@example.org>||2019-11-14 10:46:16 -0600|
|parent||dt-bindings: power: Convert Samsung Exynos Power Domain bindings to json-schema (diff)|
dt-bindings: Improve validation build error handling
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 <email@example.com> Tested-by: Jeffrey Hugo <firstname.lastname@example.org> Signed-off-by: Rob Herring <email@example.com>
Diffstat (limited to 'Documentation/devicetree/writing-schema.rst')
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/writing-schema.rst
index 3fce61cfd649..efcd5d21dc2b 100644
@@ -133,11 +133,13 @@ binding schema. All of the DT binding documents can be validated using the
-In order to perform validation of DT source files, use the `dtbs_check` target::
+In order to perform validation of DT source files, use the ``dtbs_check`` target::
-This will first run the `dt_binding_check` which generates the processed schema.
+Note that ``dtbs_check`` will skip any binding schema files with errors. It is
+necessary to use ``dt_binding_check`` to get all the validation errors in the
+binding schema files.
It is also possible to run checks with a single schema file by setting the
``DT_SCHEMA_FILES`` variable to a specific schema file.