mbox series

[0/3] Krait Documentation conversion

Message ID 20220429121739.28584-1-ansuelsmth@gmail.com
Headers show
Series Krait Documentation conversion | expand

Message

Christian Marangi April 29, 2022, 12:17 p.m. UTC
This series convert the krait-cc and the kpps-acc/gcc Documentation to
yaml.

This series comes form a split of a bigger series that got too big and
now hard to review.

While they are still more or less wrong and doesn't really reflect real
driver implementation, they are converted to prepare for a fixup later
when dts and driver are finally fixed. For now make a 1:1 conversion.

Ansuel Smith (3):
  dt-bindings: clock: Convert qcom,krait-cc to yaml
  dt-bindings: arm: msm: Convert kpss-acc driver Documentation to yaml
  dt-bindings: arm: msm: Convert kpss-gcc driver Documentation to yaml

 .../bindings/arm/msm/qcom,kpss-acc.txt        | 49 ----------
 .../bindings/arm/msm/qcom,kpss-acc.yaml       | 94 +++++++++++++++++++
 .../bindings/arm/msm/qcom,kpss-gcc.txt        | 44 ---------
 .../bindings/arm/msm/qcom,kpss-gcc.yaml       | 63 +++++++++++++
 .../bindings/clock/qcom,krait-cc.txt          | 34 -------
 .../bindings/clock/qcom,krait-cc.yaml         | 59 ++++++++++++
 6 files changed, 216 insertions(+), 127 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-acc.txt
 create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-acc.yaml
 delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.txt
 create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml
 delete mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml

Comments

Christian Marangi April 29, 2022, 3:57 p.m. UTC | #1
On Fri, Apr 29, 2022 at 10:53:16AM -0500, Rob Herring wrote:
> On Fri, 29 Apr 2022 14:17:39 +0200, Ansuel Smith wrote:
> > Convert kpss-gcc driver Documentation to yaml.
> > 
> > Signed-off-by: Ansuel Smith <ansuelsmth@gmail.com>
> > ---
> >  .../bindings/arm/msm/qcom,kpss-gcc.txt        | 44 -------------
> >  .../bindings/arm/msm/qcom,kpss-gcc.yaml       | 63 +++++++++++++++++++
> >  2 files changed, 63 insertions(+), 44 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.txt
> >  create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml
> > 
> 
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml: properties: '#clock-cells' is a dependency of 'clock-output-names'

Erm how to fix this? I can't do a 1:1 conversion if the source was
wrong and also have no bot warning.
Or I should just push an additional patch to fix this error after the
conversion?

> 	from schema $id: http://devicetree.org/meta-schemas/clocks.yaml#
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml: ignoring, error in schema: properties
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb: clock-controller@2011000: '#clock-cells' is a dependency of 'clock-output-names'
> 	From schema: /usr/local/lib/python3.10/dist-packages/dtschema/schemas/clock/clock.yaml
> Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb:0:0: /example-0/clock-controller@2011000: failed to match any schema with compatible: ['qcom,kpss-gcc-ipq8064', 'qcom,kpss-gcc']
> Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb:0:0: /example-0/clock-controller@2011000: failed to match any schema with compatible: ['qcom,kpss-gcc-ipq8064', 'qcom,kpss-gcc']
> 
> doc reference errors (make refcheckdocs):
> 
> See https://patchwork.ozlabs.org/patch/
> 
> This check can fail if there are any dependencies. The base for a patch
> series is generally the most recent rc1.
> 
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
> 
> pip3 install dtschema --upgrade
> 
> Please check and re-submit.
>
Dmitry Baryshkov April 29, 2022, 4:03 p.m. UTC | #2
On Fri, 29 Apr 2022 at 18:59, Ansuel Smith <ansuelsmth@gmail.com> wrote:
>
> On Fri, Apr 29, 2022 at 10:53:16AM -0500, Rob Herring wrote:
> > On Fri, 29 Apr 2022 14:17:39 +0200, Ansuel Smith wrote:
> > > Convert kpss-gcc driver Documentation to yaml.
> > >
> > > Signed-off-by: Ansuel Smith <ansuelsmth@gmail.com>
> > > ---
> > >  .../bindings/arm/msm/qcom,kpss-gcc.txt        | 44 -------------
> > >  .../bindings/arm/msm/qcom,kpss-gcc.yaml       | 63 +++++++++++++++++++
> > >  2 files changed, 63 insertions(+), 44 deletions(-)
> > >  delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.txt
> > >  create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml
> > >
> >
> > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> > on your patch (DT_CHECKER_FLAGS is new in v5.13):
> >
> > yamllint warnings/errors:
> >
> > dtschema/dtc warnings/errors:
> > /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml: properties: '#clock-cells' is a dependency of 'clock-output-names'
>
> Erm how to fix this? I can't do a 1:1 conversion if the source was
> wrong and also have no bot warning.
> Or I should just push an additional patch to fix this error after the
> conversion?

You can fix obvious simple mistakes and describe your chains in the
commit message.

>
> >       from schema $id: http://devicetree.org/meta-schemas/clocks.yaml#
> > /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml: ignoring, error in schema: properties
> > /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb: clock-controller@2011000: '#clock-cells' is a dependency of 'clock-output-names'
> >       From schema: /usr/local/lib/python3.10/dist-packages/dtschema/schemas/clock/clock.yaml
> > Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb:0:0: /example-0/clock-controller@2011000: failed to match any schema with compatible: ['qcom,kpss-gcc-ipq8064', 'qcom,kpss-gcc']
> > Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.example.dtb:0:0: /example-0/clock-controller@2011000: failed to match any schema with compatible: ['qcom,kpss-gcc-ipq8064', 'qcom,kpss-gcc']
> >
> > doc reference errors (make refcheckdocs):
> >
> > See https://patchwork.ozlabs.org/patch/
> >
> > This check can fail if there are any dependencies. The base for a patch
> > series is generally the most recent rc1.
> >
> > If you already ran 'make dt_binding_check' and didn't see the above
> > error(s), then make sure 'yamllint' is installed and dt-schema is up to
> > date:
> >
> > pip3 install dtschema --upgrade
> >
> > Please check and re-submit.
> >
>
> --
>         Ansuel
Rob Herring (Arm) April 29, 2022, 9:31 p.m. UTC | #3
On Fri, Apr 29, 2022 at 10:45:09PM +0200, Ansuel Smith wrote:
> On Fri, Apr 29, 2022 at 10:43:21PM +0200, Krzysztof Kozlowski wrote:
> > On 29/04/2022 17:57, Ansuel Smith wrote:
> > > On Fri, Apr 29, 2022 at 10:53:16AM -0500, Rob Herring wrote:
> > >> On Fri, 29 Apr 2022 14:17:39 +0200, Ansuel Smith wrote:
> > >>> Convert kpss-gcc driver Documentation to yaml.
> > >>>
> > >>> Signed-off-by: Ansuel Smith <ansuelsmth@gmail.com>
> > >>> ---
> > >>>  .../bindings/arm/msm/qcom,kpss-gcc.txt        | 44 -------------
> > >>>  .../bindings/arm/msm/qcom,kpss-gcc.yaml       | 63 +++++++++++++++++++
> > >>>  2 files changed, 63 insertions(+), 44 deletions(-)
> > >>>  delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.txt
> > >>>  create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml
> > >>>
> > >>
> > >> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> > >> on your patch (DT_CHECKER_FLAGS is new in v5.13):
> > >>
> > >> yamllint warnings/errors:
> > >>
> > >> dtschema/dtc warnings/errors:
> > >> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/arm/msm/qcom,kpss-gcc.yaml: properties: '#clock-cells' is a dependency of 'clock-output-names'
> > > 
> > 
> > The patches were previously sent (even as v6) and somehow the history,
> > changelog and references disappeared...
> > 
> 
> Mhh with split how this should be handled? Putting the relevant changes
> in the cover letter?
> 
> > > Erm how to fix this? I can't do a 1:1 conversion if the source was
> > > wrong and also have no bot warning.
> > > Or I should just push an additional patch to fix this error after the
> > > conversion?
> > 
> > Didn't we agree that original bindings were not in good shape? Yet the
> > questions raised with your v6 remain actually not answered, till the bot
> > complains.
> > 
> > Please do not send the bindings which do not pass dt_binding_check.
> > 
> > Best regards,
> > Krzysztof
> 
> In v6 the last mail were with the idea of sending separate series with
> minimal changes and it was mention that it was a good idea to send only
> conversion and then send the changes with the conversion series.
> 
> Finally got the message. I should NEVER send patch with warning from
> dt_binding_check.

It's like sending code changes that don't compile...

But I wouldn't say NEVER. If you have a warning that you think is wrong 
or don't know how to fix, then send it and say that in the patch.

Rob