Re: [PATCH v5 1/3] staging: vt6655: fix camelcase in bShortSlotTime

From: Tommaso Merciai <tomm.merciai@gmail.com>
To: Dan Carpenter <dan.carpenter@oracle.com>
Cc: "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Forest Bond" <forest@alittletooquiet.net>,
	"Lucas Henneman" <lucas.henneman@linaro.org>,
	"Yujia Qiao" <rapiz@foxmail.com>,
	"Madhumitha Prabakaran" <madhumithabiw@gmail.com>,
	"Marcos Antonio de Jesus Filho" <mdejesusfilho@gmail.com>,
	"Aldas Taraškevičius" <aldas60@gmail.com>,
	"Gustavo A. R. Silva" <gustavoars@kernel.org>,
	"Deepak R Varma" <mh12gx2825@gmail.com>,
	linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v5 1/3] staging: vt6655: fix camelcase in bShortSlotTime
Date: Mon, 4 Oct 2021 19:30:06 +0200	[thread overview]
Message-ID: <20211004173006.GA13458@tom-desktop> (raw)
In-Reply-To: <20211004131525.GU2048@kadam>

On Mon, Oct 04, 2021 at 04:15:25PM +0300, Dan Carpenter wrote:
> On Mon, Oct 04, 2021 at 02:58:06PM +0200, Tommaso Merciai wrote:
> > On Mon, Oct 04, 2021 at 01:26:32PM +0300, Dan Carpenter wrote:
> > > On Thu, Sep 30, 2021 at 11:49:29PM +0200, Tommaso Merciai wrote:
> > > > On Tue, Sep 28, 2021 at 06:43:00AM +0200, Greg Kroah-Hartman wrote:
> > > > > On Mon, Sep 27, 2021 at 11:35:15PM +0200, Tommaso Merciai wrote:
> > > > > > On Mon, Sep 27, 2021 at 05:26:14PM +0200, Greg Kroah-Hartman wrote:
> > > > > > > On Sun, Sep 26, 2021 at 06:25:18PM +0200, Tommaso Merciai wrote:
> > > > > > > > Replace camel case variable bShortSlotTime with snake case
> > > > > > > > variable b_short_slot_time.
> > > > > > > 
> > > > > > > That is a very odd variable name.  Why did you pick that one?
> > > > > > > 
> > > > > > > What deos it mean?
> > > > > > > 
> > > > > > > You do understand where the original naming format came from here, and
> > > > > > > what it was trying to represent, right?  If not, please go read up on
> > > > > > > it:
> > > > > > > 	https://en.wikipedia.org/wiki/Hungarian_notation
> > > > > > > 
> > > > > > > That style is not used in Linux, and so, when converting from it, do not
> > > > > > > attempt to keep the same style present here, that is kind of pointless,
> > > > > > > don't you agree?
> > > > > > 
> > > > > >   You are definitely right. What do you think about "short_slot_time"?
> > > > > 
> > > > > "time" implies that this will hold a value of time, right?
> > > > > 
> > > > > What exactly does this variable do?  That might help in naming it
> > > > > better.
> > > > 
> > > >   Is a boolean variable, if true short slot time mode is enabled, false 
> > > >   not right?
> > > >   A good solution could be: "short_slot_mode"? What do you think about?
> > > 
> > > No.  That's a confusing name.  What is a short slot mode anyway?
> > > 
> > > regards,
> > > dan carpenter
> > 
> >   Hi Dan,
> >   My bad sorry, "short_slot_time_en".
> 
> Ah, never mind.  It means something for the protocol.  I thought it was
> driver specific.  Just use short_slot_mode like you original suggested.
> The "_en" doesn't add anything.
> 
> In the commit message you out include the information from here so that
> reviewers who don't know the wifi spec will understand the meaning.

  Thanks for the tip.

  Tommaso

> 
> regards,
> dan carpenter
> 