Re: [PATCH] net: dsa: sja1105: Remove an unprofessional word from the code comments
From: Aswin C
Date: Wed Dec 09 2020 - 06:56:18 EST
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@xxxxxxxxx> wrote:
> 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.
>
</olteanv@xxxxxxxxx>