[PATCH] docs: dt: writing-schema: add example for multiple DT_SCHEMA_FILES

[PATCH] docs: dt: writing-schema: add example for multiple DT_SCHEMA_FILES

[Hugo Villeneuve]

From: Hugo Villeneuve <hvilleneuve@dimonoff.com>

Variable DT_SCHEMA_FILES can specify multiple files, but the
documentation does not indicate how to do it. Each entry needs to be
separated by a column symbol ':'.

Add an example to make it more obvious how to specify multiple
DT_SCHEMA_FILES.

Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
---
 Documentation/devicetree/bindings/writing-schema.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
index 4a381d20f2b4..a500d3c2e12e 100644
--- a/Documentation/devicetree/bindings/writing-schema.rst
+++ b/Documentation/devicetree/bindings/writing-schema.rst
@@ -159,11 +159,13 @@ It is possible to run both in a single command::
     make dt_binding_check dtbs_check
 
 It is also possible to run checks with a subset of matching schema files by
-setting the ``DT_SCHEMA_FILES`` variable to a specific schema file or pattern.
+setting the ``DT_SCHEMA_FILES`` variable to a specific schema file, multiple
+schema files or pattern.
 
 ::
 
     make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml
+    make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
     make dt_binding_check DT_SCHEMA_FILES=/gpio/
     make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
 

base-commit: 633b47cb009d09dc8f4ba9cdb3a0ca138809c7c7
-- 
2.30.2

Re: [PATCH] docs: dt: writing-schema: add example for multiple DT_SCHEMA_FILES

[Rob Herring]

On Thu, Sep 28, 2023 at 03:02:59PM -0400, Hugo Villeneuve wrote:
> From: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> 
> Variable DT_SCHEMA_FILES can specify multiple files, but the
> documentation does not indicate how to do it. Each entry needs to be
> separated by a column symbol ':'.
> 
> Add an example to make it more obvious how to specify multiple
> DT_SCHEMA_FILES.
> 
> Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> ---
>  Documentation/devicetree/bindings/writing-schema.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
> index 4a381d20f2b4..a500d3c2e12e 100644
> --- a/Documentation/devicetree/bindings/writing-schema.rst
> +++ b/Documentation/devicetree/bindings/writing-schema.rst
> @@ -159,11 +159,13 @@ It is possible to run both in a single command::
>      make dt_binding_check dtbs_check
>  
>  It is also possible to run checks with a subset of matching schema files by
> -setting the ``DT_SCHEMA_FILES`` variable to a specific schema file or pattern.
> +setting the ``DT_SCHEMA_FILES`` variable to a specific schema file, multiple
> +schema files or pattern.

And multiple patterns. I would say: ... to 1 or more specific schema 
files or patterns (partial match of a fixed string). Each file or 
pattern should be separated by ':'.


>  
>  ::
>  
>      make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml
> +    make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
>      make dt_binding_check DT_SCHEMA_FILES=/gpio/
>      make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
>  
> 
> base-commit: 633b47cb009d09dc8f4ba9cdb3a0ca138809c7c7
> -- 
> 2.30.2
> 

Re: [PATCH] docs: dt: writing-schema: add example for multiple DT_SCHEMA_FILES

[Hugo Villeneuve]

On Mon, 2 Oct 2023 11:50:52 -0500
Rob Herring <robh@kernel.org> wrote:

> On Thu, Sep 28, 2023 at 03:02:59PM -0400, Hugo Villeneuve wrote:
> > From: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> > 
> > Variable DT_SCHEMA_FILES can specify multiple files, but the
> > documentation does not indicate how to do it. Each entry needs to be
> > separated by a column symbol ':'.
> > 
> > Add an example to make it more obvious how to specify multiple
> > DT_SCHEMA_FILES.
> > 
> > Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> > ---
> >  Documentation/devicetree/bindings/writing-schema.rst | 4 +++-
> >  1 file changed, 3 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
> > index 4a381d20f2b4..a500d3c2e12e 100644
> > --- a/Documentation/devicetree/bindings/writing-schema.rst
> > +++ b/Documentation/devicetree/bindings/writing-schema.rst
> > @@ -159,11 +159,13 @@ It is possible to run both in a single command::
> >      make dt_binding_check dtbs_check
> >  
> >  It is also possible to run checks with a subset of matching schema files by
> > -setting the ``DT_SCHEMA_FILES`` variable to a specific schema file or pattern.
> > +setting the ``DT_SCHEMA_FILES`` variable to a specific schema file, multiple
> > +schema files or pattern.
> 
> And multiple patterns. I would say: ... to 1 or more specific schema 
> files or patterns (partial match of a fixed string). Each file or 
> pattern should be separated by ':'.

Hi Rob,
makes sense also for patterns, I did not think of that.

Will send a V2 with these changes.

Thank you,
Hugo.


> 
> >  
> >  ::
> >  
> >      make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml
> > +    make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
> >      make dt_binding_check DT_SCHEMA_FILES=/gpio/
> >      make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
> >  
> > 
> > base-commit: 633b47cb009d09dc8f4ba9cdb3a0ca138809c7c7
> > -- 
> > 2.30.2
> > 
>