diff mbox

[3/4] Documentation: devicetree: Fix tps65090 typos

Message ID 1403486483-4063-4-git-send-email-afaerber@suse.de
State Accepted, archived
Commit a4e2dec0d7479232df330dad60fd00ee94767381
Headers show

Commit Message

Andreas Färber June 23, 2014, 1:21 a.m. UTC
It's vsys-l{1,2}-supply, not vsys_l{1,2}-supply.

Signed-off-by: Andreas Färber <afaerber@suse.de>
---
 Documentation/devicetree/bindings/regulator/tps65090.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Doug Anderson June 23, 2014, 5:27 p.m. UTC | #1
Andreas,

On Sun, Jun 22, 2014 at 6:21 PM, Andreas Färber <afaerber@suse.de> wrote:
> It's vsys-l{1,2}-supply, not vsys_l{1,2}-supply.
>
> Signed-off-by: Andreas Färber <afaerber@suse.de>
> ---
>  Documentation/devicetree/bindings/regulator/tps65090.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/regulator/tps65090.txt b/Documentation/devicetree/bindings/regulator/tps65090.txt
> index 34098023..ca69f5e 100644
> --- a/Documentation/devicetree/bindings/regulator/tps65090.txt
> +++ b/Documentation/devicetree/bindings/regulator/tps65090.txt
> @@ -45,8 +45,8 @@ Example:
>                 infet5-supply = <&some_reg>;
>                 infet6-supply = <&some_reg>;
>                 infet7-supply = <&some_reg>;
> -               vsys_l1-supply = <&some_reg>;
> -               vsys_l2-supply = <&some_reg>;
> +               vsys-l1-supply = <&some_reg>;
> +               vsys-l2-supply = <&some_reg>;

Your change matches the code and all existing device trees in the
Linux kernel.  I also see plenty of other bindings with dashes, so
this seems reasonable.

Reviewed-by: Doug Anderson <dianders@chromium.org>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Mark Rutland June 25, 2014, 10:47 a.m. UTC | #2
On Mon, Jun 23, 2014 at 06:27:04PM +0100, Doug Anderson wrote:
> Andreas,
> 
> On Sun, Jun 22, 2014 at 6:21 PM, Andreas Färber <afaerber@suse.de> wrote:
> > It's vsys-l{1,2}-supply, not vsys_l{1,2}-supply.
> >
> > Signed-off-by: Andreas Färber <afaerber@suse.de>
> > ---
> >  Documentation/devicetree/bindings/regulator/tps65090.txt | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/regulator/tps65090.txt b/Documentation/devicetree/bindings/regulator/tps65090.txt
> > index 34098023..ca69f5e 100644
> > --- a/Documentation/devicetree/bindings/regulator/tps65090.txt
> > +++ b/Documentation/devicetree/bindings/regulator/tps65090.txt
> > @@ -45,8 +45,8 @@ Example:
> >                 infet5-supply = <&some_reg>;
> >                 infet6-supply = <&some_reg>;
> >                 infet7-supply = <&some_reg>;
> > -               vsys_l1-supply = <&some_reg>;
> > -               vsys_l2-supply = <&some_reg>;
> > +               vsys-l1-supply = <&some_reg>;
> > +               vsys-l2-supply = <&some_reg>;
> 
> Your change matches the code and all existing device trees in the
> Linux kernel.

Could this fact please be mentioned in the commit message?

Given that:

Acked-by: Mark Rutland <mark.rutland@arm.com>

> I also see plenty of other bindings with dashes, so this seems
> reasonable.

Dashes rather than underscores are preferred/correct for property names
and compatible strings. Given no-one can possibly be using the
bad/incorrect form with underscores, fixing the documentation to use
dashes makes sense.

Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Andreas Färber June 25, 2014, 11:43 a.m. UTC | #3
Am 25.06.2014 12:47, schrieb Mark Rutland:
> On Mon, Jun 23, 2014 at 06:27:04PM +0100, Doug Anderson wrote:
>> Andreas,
>>
>> On Sun, Jun 22, 2014 at 6:21 PM, Andreas Färber <afaerber@suse.de> wrote:
>>> It's vsys-l{1,2}-supply, not vsys_l{1,2}-supply.
>>>
>>> Signed-off-by: Andreas Färber <afaerber@suse.de>
>>> ---
>>>  Documentation/devicetree/bindings/regulator/tps65090.txt | 4 ++--
>>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/Documentation/devicetree/bindings/regulator/tps65090.txt b/Documentation/devicetree/bindings/regulator/tps65090.txt
>>> index 34098023..ca69f5e 100644
>>> --- a/Documentation/devicetree/bindings/regulator/tps65090.txt
>>> +++ b/Documentation/devicetree/bindings/regulator/tps65090.txt
>>> @@ -45,8 +45,8 @@ Example:
>>>                 infet5-supply = <&some_reg>;
>>>                 infet6-supply = <&some_reg>;
>>>                 infet7-supply = <&some_reg>;
>>> -               vsys_l1-supply = <&some_reg>;
>>> -               vsys_l2-supply = <&some_reg>;
>>> +               vsys-l1-supply = <&some_reg>;
>>> +               vsys-l2-supply = <&some_reg>;
>>
>> Your change matches the code and all existing device trees in the
>> Linux kernel.
> 
> Could this fact please be mentioned in the commit message?

Yes, I admit the commit message could've been clearer in stating that
only the example is modified, not the actual specification. What about:

"Specification and existing device trees use vsys-l{1,2}-supply, not
vsys_l{1,2}-supply. Fix the example to match the specification."

Maybe also "... typos in example" in the subject.

Let me know whether I should send a v2 or let maintainers fix it up.

Regards,
Andreas

> Given that:
> 
> Acked-by: Mark Rutland <mark.rutland@arm.com>
> 
>> I also see plenty of other bindings with dashes, so this seems
>> reasonable.
> 
> Dashes rather than underscores are preferred/correct for property names
> and compatible strings. Given no-one can possibly be using the
> bad/incorrect form with underscores, fixing the documentation to use
> dashes makes sense.
> 
> Thanks,
> Mark.
Rob Herring June 25, 2014, 12:23 p.m. UTC | #4
On Wed, Jun 25, 2014 at 6:43 AM, Andreas Färber <afaerber@suse.de> wrote:
> Am 25.06.2014 12:47, schrieb Mark Rutland:
>> On Mon, Jun 23, 2014 at 06:27:04PM +0100, Doug Anderson wrote:
>>> Andreas,
>>>
>>> On Sun, Jun 22, 2014 at 6:21 PM, Andreas Färber <afaerber@suse.de> wrote:
>>>> It's vsys-l{1,2}-supply, not vsys_l{1,2}-supply.
>>>>
>>>> Signed-off-by: Andreas Färber <afaerber@suse.de>
>>>> ---
>>>>  Documentation/devicetree/bindings/regulator/tps65090.txt | 4 ++--
>>>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/regulator/tps65090.txt b/Documentation/devicetree/bindings/regulator/tps65090.txt
>>>> index 34098023..ca69f5e 100644
>>>> --- a/Documentation/devicetree/bindings/regulator/tps65090.txt
>>>> +++ b/Documentation/devicetree/bindings/regulator/tps65090.txt
>>>> @@ -45,8 +45,8 @@ Example:
>>>>                 infet5-supply = <&some_reg>;
>>>>                 infet6-supply = <&some_reg>;
>>>>                 infet7-supply = <&some_reg>;
>>>> -               vsys_l1-supply = <&some_reg>;
>>>> -               vsys_l2-supply = <&some_reg>;
>>>> +               vsys-l1-supply = <&some_reg>;
>>>> +               vsys-l2-supply = <&some_reg>;
>>>
>>> Your change matches the code and all existing device trees in the
>>> Linux kernel.
>>
>> Could this fact please be mentioned in the commit message?
>
> Yes, I admit the commit message could've been clearer in stating that
> only the example is modified, not the actual specification. What about:
>
> "Specification and existing device trees use vsys-l{1,2}-supply, not
> vsys_l{1,2}-supply. Fix the example to match the specification."
>
> Maybe also "... typos in example" in the subject.
>
> Let me know whether I should send a v2 or let maintainers fix it up.

Please send v2.

Rob
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/regulator/tps65090.txt b/Documentation/devicetree/bindings/regulator/tps65090.txt
index 34098023..ca69f5e 100644
--- a/Documentation/devicetree/bindings/regulator/tps65090.txt
+++ b/Documentation/devicetree/bindings/regulator/tps65090.txt
@@ -45,8 +45,8 @@  Example:
 		infet5-supply = <&some_reg>;
 		infet6-supply = <&some_reg>;
 		infet7-supply = <&some_reg>;
-		vsys_l1-supply = <&some_reg>;
-		vsys_l2-supply = <&some_reg>;
+		vsys-l1-supply = <&some_reg>;
+		vsys-l2-supply = <&some_reg>;
 
 		regulators {
 			dcdc1 {