[PATCH] gre: fix spelling in comments

[PATCH] gre: fix spelling in comments

[Stephen Hemminger]

The original spelling and bad word choice makes these comments hard to read.

Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>

--- a/net/ipv4/ip_gre.c	2012-02-24 10:04:41.007678920 -0800
+++ b/net/ipv4/ip_gre.c	2012-02-24 10:07:54.421769389 -0800
@@ -65,7 +65,7 @@
    it is infeasible task. The most general solutions would be
    to keep skb->encapsulation counter (sort of local ttl),
    and silently drop packet when it expires. It is a good
-   solution, but it supposes maintaing new variable in ALL
+   solution, but it supposes maintaining new variable in ALL
    skb, even if no tunneling is used.
 
    Current solution: xmit_recursion breaks dead loops. This is a percpu
@@ -91,14 +91,14 @@
 
    One of them is to parse packet trying to detect inner encapsulation
    made by our node. It is difficult or even impossible, especially,
-   taking into account fragmentation. TO be short, tt is not solution at all.
+   taking into account fragmentation. TO be short, ttl is not solution at all.
 
    Current solution: The solution was UNEXPECTEDLY SIMPLE.
    We force DF flag on tunnels with preconfigured hop limit,
    that is ALL. :-) Well, it does not remove the problem completely,
    but exponential growth of network traffic is changed to linear
    (branches, that exceed pmtu are pruned) and tunnel mtu
-   fastly degrades to value <68, where looping stops.
+   rapidly degrades to value <68, where looping stops.
    Yes, it is not good if there exists a router in the loop,
    which does not force DF, even when encapsulating packets have DF set.
    But it is not our problem! Nobody could accuse us, we made
@@ -457,8 +457,8 @@ static void ipgre_err(struct sk_buff *sk
    GRE tunnels with enabled checksum. Tell them "thank you".
 
    Well, I wonder, rfc1812 was written by Cisco employee,
-   what the hell these idiots break standrads established
-   by themself???
+   what the hell these idiots break standards established
+   by themselves???
  */
 
 	const struct iphdr *iph = (const struct iphdr *)skb->data;

Re: [PATCH] gre: fix spelling in comments

[Ben Hutchings]

On Fri, 2012-02-24 at 10:08 -0800, Stephen Hemminger wrote:
> The original spelling and bad word choice makes these comments hard to read.

Not to mention weird capitalisation.

> Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>
> 
> --- a/net/ipv4/ip_gre.c	2012-02-24 10:04:41.007678920 -0800
> +++ b/net/ipv4/ip_gre.c	2012-02-24 10:07:54.421769389 -0800
> @@ -65,7 +65,7 @@
>     it is infeasible task. The most general solutions would be
>     to keep skb->encapsulation counter (sort of local ttl),

'ttl' is an abbreviation, and not a variable name here, so should be
capitalised.

>     and silently drop packet when it expires. It is a good
> -   solution, but it supposes maintaing new variable in ALL
> +   solution, but it supposes maintaining new variable in ALL
>     skb, even if no tunneling is used.
>  
>     Current solution: xmit_recursion breaks dead loops. This is a percpu
> @@ -91,14 +91,14 @@
>  
>     One of them is to parse packet trying to detect inner encapsulation
>     made by our node. It is difficult or even impossible, especially,
> -   taking into account fragmentation. TO be short, tt is not solution at all.
> +   taking into account fragmentation. TO be short, ttl is not solution at all.

'TO' shouldn't be capitalised.

>  
>     Current solution: The solution was UNEXPECTEDLY SIMPLE.

'UNEXPECTEDLY SIMPLE' shouldn't be capitalised.  Also, after the passage
of a few years, this is perhaps no longer unexpected at all...

>     We force DF flag on tunnels with preconfigured hop limit,
>     that is ALL. :-) Well, it does not remove the problem completely,
>     but exponential growth of network traffic is changed to linear
>     (branches, that exceed pmtu are pruned) and tunnel mtu

'pmtu' and 'mtu' should be capitalised.

> -   fastly degrades to value <68, where looping stops.
> +   rapidly degrades to value <68, where looping stops.
>     Yes, it is not good if there exists a router in the loop,
>     which does not force DF, even when encapsulating packets have DF set.
>     But it is not our problem! Nobody could accuse us, we made
> @@ -457,8 +457,8 @@ static void ipgre_err(struct sk_buff *sk
>     GRE tunnels with enabled checksum. Tell them "thank you".
>  
>     Well, I wonder, rfc1812 was written by Cisco employee,

'rfc' should be capitalised.

> -   what the hell these idiots break standrads established
> -   by themself???
> +   what the hell these idiots break standards established
> +   by themselves???
>   */
>  
>  	const struct iphdr *iph = (const struct iphdr *)skb->data;

Insults also detract from the readability as a technical description.

Ben.

-- 
Ben Hutchings, Staff Engineer, Solarflare
Not speaking for my employer; that's the marketing department's job.
They asked us to note that Solarflare product names are trademarked.

Re: [PATCH] gre: fix spelling in comments

[Stephen Hemminger]

On Fri, 24 Feb 2012 19:17:25 +0000
Ben Hutchings <bhutchings@solarflare.com> wrote:

> On Fri, 2012-02-24 at 10:08 -0800, Stephen Hemminger wrote:
> > The original spelling and bad word choice makes these comments hard to read.
> 
> Not to mention weird capitalisation.
> 
> > Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>
> > 
> > --- a/net/ipv4/ip_gre.c	2012-02-24 10:04:41.007678920 -0800
> > +++ b/net/ipv4/ip_gre.c	2012-02-24 10:07:54.421769389 -0800
> > @@ -65,7 +65,7 @@
> >     it is infeasible task. The most general solutions would be
> >     to keep skb->encapsulation counter (sort of local ttl),
> 
> 'ttl' is an abbreviation, and not a variable name here, so should be
> capitalised.
> 
> >     and silently drop packet when it expires. It is a good
> > -   solution, but it supposes maintaing new variable in ALL
> > +   solution, but it supposes maintaining new variable in ALL
> >     skb, even if no tunneling is used.
> >  
> >     Current solution: xmit_recursion breaks dead loops. This is a percpu
> > @@ -91,14 +91,14 @@
> >  
> >     One of them is to parse packet trying to detect inner encapsulation
> >     made by our node. It is difficult or even impossible, especially,
> > -   taking into account fragmentation. TO be short, tt is not solution at all.
> > +   taking into account fragmentation. TO be short, ttl is not solution at all.
> 
> 'TO' shouldn't be capitalised.
> 
> >  
> >     Current solution: The solution was UNEXPECTEDLY SIMPLE.
> 
> 'UNEXPECTEDLY SIMPLE' shouldn't be capitalised.  Also, after the passage
> of a few years, this is perhaps no longer unexpected at all...
> 
> >     We force DF flag on tunnels with preconfigured hop limit,
> >     that is ALL. :-) Well, it does not remove the problem completely,
> >     but exponential growth of network traffic is changed to linear
> >     (branches, that exceed pmtu are pruned) and tunnel mtu
> 
> 'pmtu' and 'mtu' should be capitalised.
> 
> > -   fastly degrades to value <68, where looping stops.
> > +   rapidly degrades to value <68, where looping stops.
> >     Yes, it is not good if there exists a router in the loop,
> >     which does not force DF, even when encapsulating packets have DF set.
> >     But it is not our problem! Nobody could accuse us, we made
> > @@ -457,8 +457,8 @@ static void ipgre_err(struct sk_buff *sk
> >     GRE tunnels with enabled checksum. Tell them "thank you".
> >  
> >     Well, I wonder, rfc1812 was written by Cisco employee,
> 
> 'rfc' should be capitalised.
> 
> > -   what the hell these idiots break standrads established
> > -   by themself???
> > +   what the hell these idiots break standards established
> > +   by themselves???
> >   */
> >  
> >  	const struct iphdr *iph = (const struct iphdr *)skb->data;
> 
> Insults also detract from the readability as a technical description.
> 
> Ben.
> 

I agree, just didn't want to got that far. But yes
those should be fixed as well.

Re: [PATCH] gre: fix spelling in comments

[David Miller]

From: Ben Hutchings <bhutchings@solarflare.com>
Date: Fri, 24 Feb 2012 19:17:25 +0000

> Insults also detract from the readability as a technical description.

I don't want to live in a world where emotion and character have
no place in our comments.  If something is seriously stupid, which
this situation is, a outburst of dismay at how broken things are is
absolutely appropriate.

Re: [PATCH] gre: fix spelling in comments

[David Miller]

From: Stephen Hemminger <shemminger@vyatta.com>
Date: Fri, 24 Feb 2012 10:08:20 -0800

> The original spelling and bad word choice makes these comments hard to read.
> 
> Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>

Applied, thanks.