2021-12-16 16:47:35

by Alexandre Ghiti

Subject: [PATCH] Documentation: bindings: Warn about yamllint and dt-schema before submitting patches

Make sure people know that yamllint must be installed and dt-schema up
to date before they submit device tree bindings patches.

Signed-off-by: Alexandre Ghiti <[email protected]>
---
Documentation/devicetree/bindings/submitting-patches.rst | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index 36a17b250ccc..3553e90bef5a 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -25,6 +25,10 @@ I. For patch submitters

make dt_binding_check

+ Make sure yamllint is installed and dt-schema is up to date::
+
+ pip3 install dtschema --upgrade
+
See Documentation/devicetree/bindings/writing-schema.rst for more details
about schema and tools setup.

--
2.32.0

2021-12-22 17:17:16

by Rob Herring (Arm)

Subject: Re: [PATCH] Documentation: bindings: Warn about yamllint and dt-schema before submitting patches

On Thu, Dec 16, 2021 at 05:47:27PM +0100, Alexandre Ghiti wrote:
> Make sure people know that yamllint must be installed and dt-schema up
> to date before they submit device tree bindings patches.
>
> Signed-off-by: Alexandre Ghiti <[email protected]>
> ---
> Documentation/devicetree/bindings/submitting-patches.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
> index 36a17b250ccc..3553e90bef5a 100644
> --- a/Documentation/devicetree/bindings/submitting-patches.rst
> +++ b/Documentation/devicetree/bindings/submitting-patches.rst
> @@ -25,6 +25,10 @@ I. For patch submitters
>
> make dt_binding_check
>

This will already tell you if dt-schema is out of date.

yamllint is optional for the build system, but we could make it
required or warn when not present. I think people do get surprised by
yamllint warnings reported.

> + Make sure yamllint is installed and dt-schema is up to date::
> +
> + pip3 install dtschema --upgrade
> +
> See Documentation/devicetree/bindings/writing-schema.rst for more details

This already has details on running pip3, so now we have it in 2 places.
And they don't match because writing-schema.rst says how to install from
git rather than pypi. Not sure what happens if you install from git and
then run the above...

> about schema and tools setup.
>
> --
> 2.32.0
>
>