[PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments

[PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments

[Aswin C]

Remove the word 'retarded' from the code comments with a more professional word
'erroneous' to make it less profane.
---
 drivers/net/dsa/sja1105/sja1105_dynamic_config.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
index b777d3f37..7a76180f3 100644
--- a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
+++ b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
@@ -250,7 +250,7 @@ sja1105pqrs_l2_lookup_cmd_packing(void *buf, struct sja1105_dyn_cmd *cmd,
 			SJA1105PQRS_SIZE_L2_LOOKUP_ENTRY, op);
 }
 
-/* The switch is so retarded that it makes our command/entry abstraction
+/* The switch is so erroneous that it makes our command/entry abstraction
  * crumble apart.
  *
  * On P/Q/R/S, the switch tries to say whether a FDB entry
-- 
2.29.2

Re: [PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments

[Vladimir Oltean]

Hi Aswin,

On Tue, Dec 08, 2020 at 04:03:32PM +0530, Aswin C wrote:
> Remove the word 'retarded' from the code comments with a more professional word
> 'erroneous' to make it less profane.
> ---
>  drivers/net/dsa/sja1105/sja1105_dynamic_config.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
> index b777d3f37..7a76180f3 100644
> --- a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
> +++ b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
> @@ -250,7 +250,7 @@ sja1105pqrs_l2_lookup_cmd_packing(void *buf, struct sja1105_dyn_cmd *cmd,
>  			SJA1105PQRS_SIZE_L2_LOOKUP_ENTRY, op);
>  }
>  
> -/* The switch is so retarded that it makes our command/entry abstraction
> +/* The switch is so erroneous that it makes our command/entry abstraction
>   * crumble apart.
>   *
>   * On P/Q/R/S, the switch tries to say whether a FDB entry
> -- 
> 2.29.2
> 

Thank you for the patch and for what looks like your first contribution
to the kernel. First of all, when you submit a patch, you should follow
the development process at:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
https://www.kernel.org/doc/Documentation/networking/netdev-FAQ.rst

You should use ./scripts/get_maintainer.pl and send the email to all
maintainers that get listed there, plus the mailing list.

I don't feel that "erroneous" is the right replacement. Maybe "poorly organized".

Although I am not sure that "professional" is something that I was going
for when I wrote this driver.

This makes me curious what exactly motivated you to make the change? Do
you feel offended by the use of profanity when used to describe hardware?
How did you even pick the sja1105 driver. I can think of two possibilities:
- You are working with it. But in this case, I do wonder how you feel by
  the larger amount of profanity in drivers/net/dsa/sja1105/sja1105_tas.c.
  Are you planning further patches for that?
- You just searched the kernel sources for profanity, or, putting it
  differently, you were actively trying to be offended.

Re: [PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments

[Aswin C]

Hello. Thank you very much for the reply.

Firstly, yes, it's my first contribution and apologies for making some mistakes and I'd like to thank you for being kind and pointing it out.

I came to know about this driver in a casual discussion among my peers when one of them pointed out the presence of this particular word on the driver. I just thought that I'd try to help and get rid of that, if possible. Nothing more.

As you mentioned, I ran my eyes over drivers/net/dsa/sja1105/sja1105_tas.c and the other files. Other than a very minor spelling error, I didn't come across wording conventions like the one we are discussing about.

And yes, as you mentioned, "poorly organized" sounds perfect, too.

I believe that not signing off and not sending it to all maintainers is all, in the things I did wrong. So, I hope I can fix them and send the patch as a reply to this thread.

Thank you.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Tuesday, December 8, 2020 6:05 PM, Vladimir Oltean <olteanv@gmail.com> wrote:

&gt; Hi Aswin,
&gt;
&gt; On Tue, Dec 08, 2020 at 04:03:32PM +0530, Aswin C wrote:
&gt;
&gt; &gt; Remove the word 'retarded' from the code comments with a more professional word
&gt; &gt; 'erroneous' to make it less profane.
&gt; &gt;
&gt; &gt; ---------------------------------------------------------------------------------------------------------------------
&gt; &gt;
&gt; &gt; drivers/net/dsa/sja1105/sja1105_dynamic_config.c | 2 +-
&gt; &gt; 1 file changed, 1 insertion(+), 1 deletion(-)
&gt; &gt; diff --git a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
&gt; &gt; index b777d3f37..7a76180f3 100644
&gt; &gt; --- a/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
&gt; &gt; +++ b/drivers/net/dsa/sja1105/sja1105_dynamic_config.c
&gt; &gt; @@ -250,7 +250,7 @@ sja1105pqrs_l2_lookup_cmd_packing(void *buf, struct sja1105_dyn_cmd *cmd,
&gt; &gt; SJA1105PQRS_SIZE_L2_LOOKUP_ENTRY, op);
&gt; &gt; }
&gt; &gt; -/* The switch is so retarded that it makes our command/entry abstraction
&gt; &gt; +/* The switch is so erroneous that it makes our command/entry abstraction
&gt; &gt;
&gt; &gt; -   crumble apart.
&gt; &gt; -
&gt; &gt; -   On P/Q/R/S, the switch tries to say whether a FDB entry
&gt; &gt;     --
&gt; &gt;     2.29.2
&gt; &gt;
&gt;
&gt; Thank you for the patch and for what looks like your first contribution
&gt; to the kernel. First of all, when you submit a patch, you should follow
&gt; the development process at:
&gt; https://www.kernel.org/doc/html/latest/process/submitting-patches.html
&gt; https://www.kernel.org/doc/Documentation/networking/netdev-FAQ.rst
&gt;
&gt; You should use ./scripts/get_maintainer.pl and send the email to all
&gt; maintainers that get listed there, plus the mailing list.
&gt;
&gt; I don't feel that "erroneous" is the right replacement. Maybe "poorly organized".
&gt;
&gt; Although I am not sure that "professional" is something that I was going
&gt; for when I wrote this driver.
&gt;
&gt; This makes me curious what exactly motivated you to make the change? Do
&gt; you feel offended by the use of profanity when used to describe hardware?
&gt; How did you even pick the sja1105 driver. I can think of two possibilities:
&gt;
&gt; -   You are working with it. But in this case, I do wonder how you feel by
&gt;     the larger amount of profanity in drivers/net/dsa/sja1105/sja1105_tas.c.
&gt;     Are you planning further patches for that?
&gt;
&gt; -   You just searched the kernel sources for profanity, or, putting it
&gt;     differently, you were actively trying to be offended.
&gt;

</olteanv@gmail.com>

Re: [PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments

[Vladimir Oltean]

Hi Aswin,

On Wed, Dec 09, 2020 at 11:54:20AM +0000, Aswin C wrote:
> Hello. Thank you very much for the reply.
>
> Firstly, yes, it's my first contribution and apologies for making some
> mistakes and I'd like to thank you for being kind and pointing it out.

No problem. Nobody is born educated, it is through mistakes that we learn.
There is also a convention for replying to email, I might add. It is to
trim down the quoted portion only to what you are replying to, and to
reply below it (and not above, aka top-posting), and to use plain text
and not HTML. This is how your email looks like in plain text. It
doesn't look pleasant to read:
https://lore.kernel.org/lkml/-gMuTlvCAcfhIMqI1V4ylxBXKdWffUwznP_0cODJaam4l3hyfEFTLkZUZMLQV23BCeO8S6vTh1OfN0yOi7M5PhfX0rOX8SkL9JknVM2nKOA=@protonmail.com/
Try to configure your email client to use plain text.

> I came to know about this driver in a casual discussion among my peers
> when one of them pointed out the presence of this particular word on
> the driver.

Who are your peers and why do they care about the Linux driver for an
automotive Ethernet switch?

> I just thought that I'd try to help and get rid of that, if possible.
> Nothing more.

So you do consider that getting rid of it is helpful. Please elaborate.

> As you mentioned, I ran my eyes over drivers/net/dsa/sja1105/sja1105_tas.c
> and the other files. Other than a very minor spelling error, I didn't
> come across wording conventions like the one we are discussing about.

Read more.

> And yes, as you mentioned, "poorly organized" sounds perfect, too.

Well, even though it may sound better to you, I am still not sure I
agree with the change. To reiterate, "professional" was not a goal of
this driver. There are other professional drivers for this hardware.
It is all for fun.

I find that suppressing negative emotions, anger, frustration, is not
helpful, as it tends to only amplify them over time. Instead, learning
to disguise aggressivity, controlling it, making it more subtle and
never directing it towards people can be good ways to let it out.
If I wasn't subtle enough or it really bothered you, I'm open to improve
and do better next time, but you'll have to convince me.

And this is not only about me. In general I believe that you will not
receive a positive reaction from people when you point out to them that
they should watch out for their language in circumstances that really do
not make any difference to you. The linux mailing lists are an amazing
place to learn from people. But engineers do not have good social
skills. You need to make concessions to others' personalities before you
could focus on the good part and learn from them. I think it would be a
shame to start your contributions to the Linux kernel in this way, by
making the language less vulgar. You sure won't be making any friends.
There are plenty of other areas you could concentrate on.

> I believe that not signing off and not sending it to all maintainers
> is all, in the things I did wrong. So, I hope I can fix them and send
> the patch as a reply to this thread.

Do not send follow-up patches in reply to existing threads. They get
lost by maintainers.
Instead, use git send-email --cover-letter="PATCH v2 net-next" and be
sure to send it to the maintainers and the networking mailing list.