| Message ID | 20211216164727.2888916-1-alexandre.ghiti@canonical.com |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | Documentation: bindings: Warn about yamllint and dt-schema before submitting patches | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | success | |
| robh/dtbs-check | success | |
| robh/dt-meta-schema | success |
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 > >
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.
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(+)