diff mbox series

[1/2] dt-bindings: watchdog: change node name to generic

Message ID 20201217000716.11091-2-g-tammana@ti.com (mailing list archive)
State New, archived
Headers show
Series Add watchdog dt nodes for TI's J7200 SoC | expand

Commit Message

Gowtham Tammana Dec. 17, 2020, 12:07 a.m. UTC
Modifying the example to use generic as node name to keep it consistent
with the generic name recommendation.

Signed-off-by: Gowtham Tammana <g-tammana@ti.com>
---
 Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Nishanth Menon Dec. 18, 2020, 2:02 p.m. UTC | #1
On 18:07-20201216, Gowtham Tammana wrote:
> Modifying the example to use generic as node name to keep it consistent
^^ Please don't state in commit message the actual change you are
doing.. We can see that from the diffstat. There are lots of
documentation now a days on smart commit messages, I suggest reading
those.

> with the generic name recommendation.


I think what you are doing here is to fix a typo in the example
provided to match with the compatible that is supposed to be used.

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation//devicetree/bindings/watchdog/ti,rti-wdt.yaml#n26

While this change is valid, please:
a) Rewrite the commit message
b) Fix $subject "dt-bindings: watchdog: change node name to generic"
"dt-bindings: watchdog" is a huge range of watchdog driver scope, you
want to narrow it to the ti,rti
dt-bindings: watchdog: ti,rti:" or What ever wdt/dt maintainers may prefer.

"change node name to generic" -> yes, diff tells us that, you are trying
to fix a typo in the example, so please use the word fix to indicate
this is a fixup, not a new 'change' ..

c) Please CC subsystem maintainers.. I suppose these go through
subsystem maintainer trees once Rob Acks..


> 
> Signed-off-by: Gowtham Tammana <g-tammana@ti.com>
> ---
>  Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> index c1348db59374..e21af390b3e9 100644
> --- a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> @@ -57,8 +57,8 @@ examples:
>       */
>      #include <dt-bindings/soc/ti,sci_pm_domain.h>
>  
> -    watchdog0: rti@2200000 {
> -        compatible = "ti,rti-wdt";
> +    watchdog0: watchdog@2200000 {
> +        compatible = "ti,j7-rti-wdt";
>          reg = <0x2200000 0x100>;
>          clocks = <&k3_clks 252 1>;
>          power-domains = <&k3_pds 252 TI_SCI_PD_EXCLUSIVE>;
> -- 
> 2.29.0
>
Gowtham Tammana Jan. 7, 2021, 1:46 a.m. UTC | #2
Nishanth Menon wrote:
> On 18:07-20201216, Gowtham Tammana wrote:
> > Modifying the example to use generic as node name to keep it consistent
> ^^ Please don't state in commit message the actual change you are
> doing.. We can see that from the diffstat. There are lots of
> documentation now a days on smart commit messages, I suggest reading
> those.
> 
> > with the generic name recommendation.
> 
> 
> I think what you are doing here is to fix a typo in the example
> provided to match with the compatible that is supposed to be used.
> 
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation//devicetree/bindings/watchdog/ti,rti-wdt.yaml#n26
> 
> While this change is valid, please:
> a) Rewrite the commit message
> b) Fix $subject "dt-bindings: watchdog: change node name to generic"
> "dt-bindings: watchdog" is a huge range of watchdog driver scope, you
> want to narrow it to the ti,rti
> dt-bindings: watchdog: ti,rti:" or What ever wdt/dt maintainers may prefer.
> 
> "change node name to generic" -> yes, diff tells us that, you are trying
> to fix a typo in the example, so please use the word fix to indicate
> this is a fixup, not a new 'change' ..
> 
> c) Please CC subsystem maintainers.. I suppose these go through
> subsystem maintainer trees once Rob Acks..

Thanks for the review here Nishant. Will make the suggested changes for v2.

Gowtham
> 
> > 
> > Signed-off-by: Gowtham Tammana <g-tammana@ti.com>
> > ---
> >  Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> > index c1348db59374..e21af390b3e9 100644
> > --- a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> > +++ b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
> > @@ -57,8 +57,8 @@ examples:
> >       */
> >      #include <dt-bindings/soc/ti,sci_pm_domain.h>
> >  
> > -    watchdog0: rti@2200000 {
> > -        compatible = "ti,rti-wdt";
> > +    watchdog0: watchdog@2200000 {
> > +        compatible = "ti,j7-rti-wdt";
> >          reg = <0x2200000 0x100>;
> >          clocks = <&k3_clks 252 1>;
> >          power-domains = <&k3_pds 252 TI_SCI_PD_EXCLUSIVE>;
> > -- 
> > 2.29.0
> > 
> 
> -- 
> Regards,
> Nishanth Menon
> Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
index c1348db59374..e21af390b3e9 100644
--- a/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/ti,rti-wdt.yaml
@@ -57,8 +57,8 @@  examples:
      */
     #include <dt-bindings/soc/ti,sci_pm_domain.h>
 
-    watchdog0: rti@2200000 {
-        compatible = "ti,rti-wdt";
+    watchdog0: watchdog@2200000 {
+        compatible = "ti,j7-rti-wdt";
         reg = <0x2200000 0x100>;
         clocks = <&k3_clks 252 1>;
         power-domains = <&k3_pds 252 TI_SCI_PD_EXCLUSIVE>;