[PATCH] docs: dt: writing-schema: Describe validating one DTB

[PATCH] docs: dt: writing-schema: Describe validating one DTB

[Krzysztof Kozlowski]

Running DT schema validation with `dtbs_check` is time consuming thus we
also have ability to check only one DTB target like:

  make -j8 DT_SCHEMA_FILES=gpio CHECK_DTBS=y qcom/sm8450-hdk.dtb

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 Documentation/devicetree/bindings/writing-schema.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
index eb8ced400c7e..6dea741c5962 100644
--- a/Documentation/devicetree/bindings/writing-schema.rst
+++ b/Documentation/devicetree/bindings/writing-schema.rst
@@ -222,6 +222,10 @@ separated by ':'.
     make dt_binding_check DT_SCHEMA_FILES=/gpio/
     make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
 
+Validation of one DT source by providing Makefile target::
+
+    make CHECK_DTBS=y target.dtb
+    make DT_SCHEMA_FILES=xxx.yaml CHECK_DTBS=y target.dtb
 
 json-schema Resources
 ---------------------
-- 
2.43.0

Re: [PATCH] docs: dt: writing-schema: Describe validating one DTB

[Rob Herring]

On Thu, Jan 23, 2025 at 03:50:09PM +0100, Krzysztof Kozlowski wrote:
> Running DT schema validation with `dtbs_check` is time consuming thus we
> also have ability to check only one DTB target like:
> 
>   make -j8 DT_SCHEMA_FILES=gpio CHECK_DTBS=y qcom/sm8450-hdk.dtb

It's kind of duplicated because "make help" has:

  make CHECK_DTBS=1 [targets] Check all generated dtb files against schema
         This can be applied both to "dtbs" and to individual "foo.dtb" targets

> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> ---
>  Documentation/devicetree/bindings/writing-schema.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
> index eb8ced400c7e..6dea741c5962 100644
> --- a/Documentation/devicetree/bindings/writing-schema.rst
> +++ b/Documentation/devicetree/bindings/writing-schema.rst
> @@ -222,6 +222,10 @@ separated by ':'.
>      make dt_binding_check DT_SCHEMA_FILES=/gpio/
>      make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
>  
> +Validation of one DT source by providing Makefile target::
> +
> +    make CHECK_DTBS=y target.dtb
> +    make DT_SCHEMA_FILES=xxx.yaml CHECK_DTBS=y target.dtb

Perhaps dir/target.dtb

Though that may prompt folks to do:

make arch/$ARCH/boot/dts/target.dtb

You need just the sub-dirs under arch/*/boot/dts/ as part of the target. 

>  
>  json-schema Resources
>  ---------------------
> -- 
> 2.43.0
> 

Re: [PATCH] docs: dt: writing-schema: Describe validating one DTB

[Krzysztof Kozlowski]

On 24/01/2025 23:39, Rob Herring wrote:
> On Thu, Jan 23, 2025 at 03:50:09PM +0100, Krzysztof Kozlowski wrote:
>> Running DT schema validation with `dtbs_check` is time consuming thus we
>> also have ability to check only one DTB target like:
>>
>>   make -j8 DT_SCHEMA_FILES=gpio CHECK_DTBS=y qcom/sm8450-hdk.dtb
> 
> It's kind of duplicated because "make help" has:
> 
>   make CHECK_DTBS=1 [targets] Check all generated dtb files against schema
>          This can be applied both to "dtbs" and to individual "foo.dtb" targets

People not always look there, so it is nice to have one place
documenting possible usages. Just like we have for C=1/coccinelle.

> 
>>
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> ---
>>  Documentation/devicetree/bindings/writing-schema.rst | 4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
>> index eb8ced400c7e..6dea741c5962 100644
>> --- a/Documentation/devicetree/bindings/writing-schema.rst
>> +++ b/Documentation/devicetree/bindings/writing-schema.rst
>> @@ -222,6 +222,10 @@ separated by ':'.
>>      make dt_binding_check DT_SCHEMA_FILES=/gpio/
>>      make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
>>  
>> +Validation of one DT source by providing Makefile target::
>> +
>> +    make CHECK_DTBS=y target.dtb
>> +    make DT_SCHEMA_FILES=xxx.yaml CHECK_DTBS=y target.dtb
> 
> Perhaps dir/target.dtb
> 
> Though that may prompt folks to do:
> 
> make arch/$ARCH/boot/dts/target.dtb
> 
> You need just the sub-dirs under arch/*/boot/dts/ as part of the target. 

I'll put that to text:

Validation of one DT source by providing Makefile target (sub-dir of dts)::

	make CHECK_DTBS=y sub-dir/target.dtb
	make DT_SCHEMA_FILES=xxx.yaml CHECK_DTBS=y sub-dir/target.dtb


Best regards,
Krzysztof