Re: [dpdk-dev] [EXT] Re: [PATCH v3] devtools: add acronyms in dictionary for commit checks

[Ashwin Sekhar Thalakalath Kottilveetil <asekhar@marvell.com>]

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Friday, September 17, 2021 7:35 PM
> To: Ashwin Sekhar Thalakalath Kottilveetil <asekhar@marvell.com>
> Cc: dev@dpdk.org; Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Sunil
> Kumar Kori <skori@marvell.com>; Satha Koteswara Rao Kottidi
> <skoteshwar@marvell.com>; Pavan Nikhilesh Bhagavatula
> <pbhagavatula@marvell.com>; Kiran Kumar Kokkilagadda
> <kirankumark@marvell.com>; Satheesh Paul <psatheesh@marvell.com>;
> Anoob Joseph <anoobj@marvell.com>; Akhil Goyal <gakhil@marvell.com>;
> ferruh.yigit@intel.com; david.marchand@redhat.com
> Subject: Re: [EXT] Re: [PATCH v3] devtools: add acronyms in dictionary for
> commit checks
> 
> 17/09/2021 15:54, Ashwin Sekhar Thalakalath Kottilveetil:
> > From: Thomas Monjalon <thomas@monjalon.net>
> > > 17/09/2021 12:58, Ashwin Sekhar T K:
> > > > Update word list with Marvell specific acronyms.
> > > >
> > > > CPT  -> Cryptographic Accelerator Unit
> > > > CQ   -> Completion Queue
> > > > LBK  -> Loopback Interface Unit
> > > > LMT  -> Large Atomic Store Unit
> > >
> > > How LMT means that?
> > LMT is how the Large Atomic Store Unit in the CNXK devices is referred to
> as.
> > It will be difficult to put a 1:1 mapping between the letters and
> > actual names.
> > >
> > > > MCAM -> Match Content Addressable Memory
> > >
> > > Is it specific to a device?
> > This is specific to Marvell CNXK devices.
> > >
> > > > NIX  -> Network Interface Controller Unit
> > >
> > > Where is it used? Is it different of NIC?
> > It is used throughout the CNXK driver code (drivers/net/cnxk). This is
> > not same as NIC.
> > >
> > > > NPA  -> Network Pool Allocator
> > > > NPC  -> Network Parser and CAM Unit ROC  -> Rest Of Chip
> > >
> > > All these stuff look device-specific. Please add details.
> > Please suggest where to add details.
> > >
> > > > RQ   -> Receive Queue
> > > > RVU  -> Resource Virtualization Unit
> > > > SQ   -> Send Queue
> > > > SSO  -> Schedule Synchronize Order Unit TIM  -> Timer Unit
> 
> Please add details in the commit log so we understand they are Marvell
> acronyms.
Commit log already mentions these are Marvell specific acronyms. I did not
add explanation for each of them as this would make the message too long.
> 
> One more question: why is useful to add? Some people forget uppercases?
Upper case is desired but not really mandatory. This was a suggestion put
forth to me In one of the reviews.
https://patches.dpdk.org/project/dpdk/patch/20210830135231.2610152-1-asekhar@marvell.com/

I can abandon this change if you feel it is not appropriate to put many
device specific acronyms in the top level word list.
> 
> 
>