diff mbox series

dt-bindings: net: dsa: mediatek,mt7530: Minor grammar fixes

Message ID 20240624025812.1729229-1-chris.packham@alliedtelesis.co.nz (mailing list archive)
State New, archived
Headers show
Series dt-bindings: net: dsa: mediatek,mt7530: Minor grammar fixes | expand

Commit Message

Chris Packham June 24, 2024, 2:58 a.m. UTC
Update the mt7530 binding with some minor updates that make the document
easier to read.

Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---

Notes:
    I was referring to this dt binding and found a couple of places where
    the wording could be improved. I'm not exactly a techical writer but
    hopefully I've made things a bit better.

 .../devicetree/bindings/net/dsa/mediatek,mt7530.yaml        | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Arınç ÜNAL June 24, 2024, 7 a.m. UTC | #1
On 24/06/2024 05.58, Chris Packham wrote:
> Update the mt7530 binding with some minor updates that make the document
> easier to read.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> ---
> 
> Notes:
>      I was referring to this dt binding and found a couple of places where
>      the wording could be improved. I'm not exactly a techical writer but
>      hopefully I've made things a bit better.
> 
>   .../devicetree/bindings/net/dsa/mediatek,mt7530.yaml        | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> index 1c2444121e60..6c0abb020631 100644
> --- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> +++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> @@ -22,16 +22,16 @@ description: |
>   
>     The MT7988 SoC comes with a built-in switch similar to MT7531 as well as four
>     Gigabit Ethernet PHYs. The switch registers are directly mapped into the SoC's
> -  memory map rather than using MDIO. The switch got an internally connected 10G
> +  memory map rather than using MDIO. The switch has an internally connected 10G
>     CPU port and 4 user ports connected to the built-in Gigabit Ethernet PHYs.
>   
> -  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs has got 10/100 PHYs
> +  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs have 10/100 PHYs

MT7530 is singular, the sentence is correct as it is.

>     and the switch registers are directly mapped into SoC's memory map rather than
>     using MDIO. The DSA driver currently doesn't support MT7620 variants.
>   
>     There is only the standalone version of MT7531.
>   
> -  Port 5 on MT7530 has got various ways of configuration:
> +  Port 5 on MT7530 supports various configurations:

This is a rewrite, not a grammar fix.

Arınç
Conor Dooley June 24, 2024, 4:29 p.m. UTC | #2
On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
> On 24/06/2024 05.58, Chris Packham wrote:
> > Update the mt7530 binding with some minor updates that make the document
> > easier to read.
> > 
> > Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> > ---
> > 
> > Notes:
> >      I was referring to this dt binding and found a couple of places where
> >      the wording could be improved. I'm not exactly a techical writer but
> >      hopefully I've made things a bit better.
> > 
> >   .../devicetree/bindings/net/dsa/mediatek,mt7530.yaml        | 6 +++---
> >   1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > index 1c2444121e60..6c0abb020631 100644
> > --- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > +++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > @@ -22,16 +22,16 @@ description: |
> >     The MT7988 SoC comes with a built-in switch similar to MT7531 as well as four
> >     Gigabit Ethernet PHYs. The switch registers are directly mapped into the SoC's
> > -  memory map rather than using MDIO. The switch got an internally connected 10G
> > +  memory map rather than using MDIO. The switch has an internally connected 10G
> >     CPU port and 4 user ports connected to the built-in Gigabit Ethernet PHYs.
> > -  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs has got 10/100 PHYs
> > +  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs have 10/100 PHYs
> 
> MT7530 is singular, the sentence is correct as it is.

Actually, the sentence is missing a definite article, so is not correct
as-is.

> 
> >     and the switch registers are directly mapped into SoC's memory map rather than
> >     using MDIO. The DSA driver currently doesn't support MT7620 variants.
> >     There is only the standalone version of MT7531.
> > -  Port 5 on MT7530 has got various ways of configuration:
> > +  Port 5 on MT7530 supports various configurations:
> 
> This is a rewrite, not a grammar fix.

In both cases "has got" is clumsy wording, "supports" is an improvement
to readability, even if it might not qualify as a grammar fix.
Arınç ÜNAL June 24, 2024, 4:59 p.m. UTC | #3
On 24/06/2024 19.29, Conor Dooley wrote:
> On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
>> On 24/06/2024 05.58, Chris Packham wrote:
>>> Update the mt7530 binding with some minor updates that make the document
>>> easier to read.
>>>
>>> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
>>> ---
>>>
>>> Notes:
>>>       I was referring to this dt binding and found a couple of places where
>>>       the wording could be improved. I'm not exactly a techical writer but
>>>       hopefully I've made things a bit better.
>>>
>>>    .../devicetree/bindings/net/dsa/mediatek,mt7530.yaml        | 6 +++---
>>>    1 file changed, 3 insertions(+), 3 deletions(-)
>>>
>>> diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
>>> index 1c2444121e60..6c0abb020631 100644
>>> --- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
>>> +++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
>>> @@ -22,16 +22,16 @@ description: |
>>>      The MT7988 SoC comes with a built-in switch similar to MT7531 as well as four
>>>      Gigabit Ethernet PHYs. The switch registers are directly mapped into the SoC's
>>> -  memory map rather than using MDIO. The switch got an internally connected 10G
>>> +  memory map rather than using MDIO. The switch has an internally connected 10G
>>>      CPU port and 4 user ports connected to the built-in Gigabit Ethernet PHYs.
>>> -  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs has got 10/100 PHYs
>>> +  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs have 10/100 PHYs
>>
>> MT7530 is singular, the sentence is correct as it is.
> 
> Actually, the sentence is missing a definite article, so is not correct
> as-is.

The definite article is omitted for the sake of brevity. I don't believe
omitting the definite article renders the sentence incorrect.

> 
>>
>>>      and the switch registers are directly mapped into SoC's memory map rather than
>>>      using MDIO. The DSA driver currently doesn't support MT7620 variants.
>>>      There is only the standalone version of MT7531.
>>> -  Port 5 on MT7530 has got various ways of configuration:
>>> +  Port 5 on MT7530 supports various configurations:
>>
>> This is a rewrite, not a grammar fix.
> 
> In both cases "has got" is clumsy wording,

We don't use "have/has" on the other side of the Atlantic often.

Arınç
Conor Dooley June 24, 2024, 5:02 p.m. UTC | #4
On Mon, Jun 24, 2024 at 07:59:48PM +0300, Arınç ÜNAL wrote:
> On 24/06/2024 19.29, Conor Dooley wrote:
> > On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
> > > On 24/06/2024 05.58, Chris Packham wrote:

> > > >      and the switch registers are directly mapped into SoC's memory map rather than
> > > >      using MDIO. The DSA driver currently doesn't support MT7620 variants.
> > > >      There is only the standalone version of MT7531.
> > > > -  Port 5 on MT7530 has got various ways of configuration:
> > > > +  Port 5 on MT7530 supports various configurations:
> > > 
> > > This is a rewrite, not a grammar fix.
> > 
> > In both cases "has got" is clumsy wording,
> 
> We don't use "have/has" on the other side of the Atlantic often.

Uh, which side do you think I am from?
Conor Dooley June 24, 2024, 5:05 p.m. UTC | #5
On Mon, Jun 24, 2024 at 07:59:48PM +0300, Arınç ÜNAL wrote:
> On 24/06/2024 19.29, Conor Dooley wrote:
> > On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
> > > On 24/06/2024 05.58, Chris Packham wrote:
> > > > Update the mt7530 binding with some minor updates that make the document
> > > > easier to read.
> > > > 
> > > > Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> > > > ---
> > > > 
> > > > Notes:
> > > >       I was referring to this dt binding and found a couple of places where
> > > >       the wording could be improved. I'm not exactly a techical writer but
> > > >       hopefully I've made things a bit better.
> > > > 
> > > >    .../devicetree/bindings/net/dsa/mediatek,mt7530.yaml        | 6 +++---
> > > >    1 file changed, 3 insertions(+), 3 deletions(-)
> > > > 
> > > > diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > > > index 1c2444121e60..6c0abb020631 100644
> > > > --- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > > > +++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
> > > > @@ -22,16 +22,16 @@ description: |
> > > >      The MT7988 SoC comes with a built-in switch similar to MT7531 as well as four
> > > >      Gigabit Ethernet PHYs. The switch registers are directly mapped into the SoC's
> > > > -  memory map rather than using MDIO. The switch got an internally connected 10G
> > > > +  memory map rather than using MDIO. The switch has an internally connected 10G
> > > >      CPU port and 4 user ports connected to the built-in Gigabit Ethernet PHYs.
> > > > -  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs has got 10/100 PHYs
> > > > +  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs have 10/100 PHYs
> > > 
> > > MT7530 is singular, the sentence is correct as it is.
> > 
> > Actually, the sentence is missing a definite article, so is not correct
> > as-is.
> 
> The definite article is omitted for the sake of brevity. I don't believe
> omitting the definite article renders the sentence incorrect.

I figured if we were gonna nitpick wording, we should nitpick it
properly :)
Arınç ÜNAL June 24, 2024, 5:11 p.m. UTC | #6
On 24/06/2024 20.02, Conor Dooley wrote:
> On Mon, Jun 24, 2024 at 07:59:48PM +0300, Arınç ÜNAL wrote:
>> On 24/06/2024 19.29, Conor Dooley wrote:
>>> On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
>>>> On 24/06/2024 05.58, Chris Packham wrote:
> 
>>>>>       and the switch registers are directly mapped into SoC's memory map rather than
>>>>>       using MDIO. The DSA driver currently doesn't support MT7620 variants.
>>>>>       There is only the standalone version of MT7531.
>>>>> -  Port 5 on MT7530 has got various ways of configuration:
>>>>> +  Port 5 on MT7530 supports various configurations:
>>>>
>>>> This is a rewrite, not a grammar fix.
>>>
>>> In both cases "has got" is clumsy wording,
>>
>> We don't use "have/has" on the other side of the Atlantic often.
> 
> Uh, which side do you think I am from?

Who would call it clumsy to use "have" and "got" together for possession...
Must be an Irishman! :D
Conor Dooley June 25, 2024, 4:16 p.m. UTC | #7
On Mon, Jun 24, 2024 at 08:11:10PM +0300, Arınç ÜNAL wrote:
> On 24/06/2024 20.02, Conor Dooley wrote:
> > On Mon, Jun 24, 2024 at 07:59:48PM +0300, Arınç ÜNAL wrote:
> > > On 24/06/2024 19.29, Conor Dooley wrote:
> > > > On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
> > > > > On 24/06/2024 05.58, Chris Packham wrote:
> > 
> > > > > >       and the switch registers are directly mapped into SoC's memory map rather than
> > > > > >       using MDIO. The DSA driver currently doesn't support MT7620 variants.
> > > > > >       There is only the standalone version of MT7531.
> > > > > > -  Port 5 on MT7530 has got various ways of configuration:
> > > > > > +  Port 5 on MT7530 supports various configurations:
> > > > > 
> > > > > This is a rewrite, not a grammar fix.
> > > > 
> > > > In both cases "has got" is clumsy wording,
> > > 
> > > We don't use "have/has" on the other side of the Atlantic often.
> > 
> > Uh, which side do you think I am from?
> 
> Who would call it clumsy to use "have" and "got" together for possession...
> Must be an Irishman! :D

Okay, I was just making sure you weren't accusing me of being
American...
Arınç ÜNAL June 25, 2024, 4:34 p.m. UTC | #8
On 25/06/2024 19.16, Conor Dooley wrote:
> On Mon, Jun 24, 2024 at 08:11:10PM +0300, Arınç ÜNAL wrote:
>> On 24/06/2024 20.02, Conor Dooley wrote:
>>> On Mon, Jun 24, 2024 at 07:59:48PM +0300, Arınç ÜNAL wrote:
>>>> On 24/06/2024 19.29, Conor Dooley wrote:
>>>>> On Mon, Jun 24, 2024 at 10:00:25AM +0300, Arınç ÜNAL wrote:
>>>>>> On 24/06/2024 05.58, Chris Packham wrote:
>>>
>>>>>>>        and the switch registers are directly mapped into SoC's memory map rather than
>>>>>>>        using MDIO. The DSA driver currently doesn't support MT7620 variants.
>>>>>>>        There is only the standalone version of MT7531.
>>>>>>> -  Port 5 on MT7530 has got various ways of configuration:
>>>>>>> +  Port 5 on MT7530 supports various configurations:
>>>>>>
>>>>>> This is a rewrite, not a grammar fix.
>>>>>
>>>>> In both cases "has got" is clumsy wording,
>>>>
>>>> We don't use "have/has" on the other side of the Atlantic often.
>>>
>>> Uh, which side do you think I am from?
>>
>> Who would call it clumsy to use "have" and "got" together for possession...
>> Must be an Irishman! :D
> 
> Okay, I was just making sure you weren't accusing me of being
> American...

Wouldn't be a bigger insult than calling you British anyway. :D

Arınç
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
index 1c2444121e60..6c0abb020631 100644
--- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
@@ -22,16 +22,16 @@  description: |
 
   The MT7988 SoC comes with a built-in switch similar to MT7531 as well as four
   Gigabit Ethernet PHYs. The switch registers are directly mapped into the SoC's
-  memory map rather than using MDIO. The switch got an internally connected 10G
+  memory map rather than using MDIO. The switch has an internally connected 10G
   CPU port and 4 user ports connected to the built-in Gigabit Ethernet PHYs.
 
-  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs has got 10/100 PHYs
+  MT7530 in MT7620AN, MT7620DA, MT7620DAN and MT7620NN SoCs have 10/100 PHYs
   and the switch registers are directly mapped into SoC's memory map rather than
   using MDIO. The DSA driver currently doesn't support MT7620 variants.
 
   There is only the standalone version of MT7531.
 
-  Port 5 on MT7530 has got various ways of configuration:
+  Port 5 on MT7530 supports various configurations:
 
     - Port 5 can be used as a CPU port.