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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <YcNdlaxuGzhDlNKf@robh.at.kernel.org>
Date:   Wed, 22 Dec 2021 13:17:09 -0400
From:   Rob Herring <robh@...nel.org>
To:     Alexandre Ghiti <alexandre.ghiti@...onical.com>
Cc:     devicetree@...r.kernel.org, linux-kernel@...r.kernel.org
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 <alexandre.ghiti@...onical.com>
> ---
>  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
> 
>