lkml.org 
[lkml]   [2021]   [Dec]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [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@canonical.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
>
>

\
 
 \ /
  Last update: 2021-12-22 18:18    [W:0.043 / U:0.076 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site