Re: [PATCH] staging: vt6655: Rename byPreambleType field

[Greg KH <gregkh@linuxfoundation.org>]

On Thu, Oct 14, 2021 at 06:47:29PM +0100, Karolina Drobnik wrote:
> Hi,
> 
> On Thu, 2021-10-14 at 17:36 +0200, Greg KH wrote:
> > On Thu, Oct 14, 2021 at 04:15:43PM +0100, Karolina Drobnik wrote:
> > > Drop Hungarian notation prefix in `byPreambleType` member of
> > > struct vnt_private. Change it to use snake case.
> > >
> > > Fix issue detected by checkpatch.pl:
> > >   CHECK: Avoid CamelCase: <byPreambleType>
> > >
> > > Signed-off-by: Karolina Drobnik <karolinadrobnik@gmail.com>
> > > ---
> > >  drivers/staging/vt6655/baseband.c    | 10 +++---
> > >  drivers/staging/vt6655/baseband.h    |  2 +-
> > >  drivers/staging/vt6655/device.h      |  2 +-
> > >  drivers/staging/vt6655/device_main.c |  8 ++---
> > >  drivers/staging/vt6655/rxtx.c        | 50
> > > ++++++++++++++--------------
> > >  5 files changed, 36 insertions(+), 36 deletions(-)
> > >
> > > diff --git a/drivers/staging/vt6655/baseband.c
> > > b/drivers/staging/vt6655/baseband.c
> > > index 0bae35af6e0f..69739de927be 100644
> > > --- a/drivers/staging/vt6655/baseband.c
> > > +++ b/drivers/staging/vt6655/baseband.c
> > > @@ -1691,8 +1691,8 @@ static const unsigned short
> > > awc_frame_time[MAX_RATE] = {
> > >   *
> > >   * Parameters:
> > >   *  In:
> > > - *      by_preamble_type  - Preamble Type
> > > - *      by_pkt_type        - PK_TYPE_11A, PK_TYPE_11B,
> > > PK_TYPE_11GB, PK_TYPE_11GA
> > > + *      preamble_type     - Preamble Type
> > > + *      by_pkt_type       - PK_TYPE_11A, PK_TYPE_11B,
> > > PK_TYPE_11GB, PK_TYPE_11GA
> >
> > This is not described in your changelog as something you did.  Are
> > you sure you are not mixing up different changes in one patch?
> 
> I added whitespace in `by_pkt_type` line to align hyphens after the
> name change. Should I mention it in the description or just revert it?

Each patch should only do one logical thing.  And every "thing" you do,
has to be described in the changelog text.

thanks,

greg k-h