Re: [PATCH 0/4] Coding style clean-up

["Wang, Jian J" <jian.j.wang@intel.com>]

Current ECC use <type-name>.<field-name> in exception list to exclude those special
field name spec defined. Whenever there's a new structure introduced with those field
names, which have been added to exception list, the ECC will still report coding style
violation. Maybe we can just use <field-name> to do field name match for any structure
type to exclude those special names. This can avoid the false reports as many as possible.

Regards,
Jian


> -----Original Message-----
> From: Kinney, Michael D
> Sent: Thursday, December 28, 2017 12:35 AM
> To: Wang, Jian J <jian.j.wang@intel.com>; edk2-devel@lists.01.org; Kinney,
> Michael D <michael.d.kinney@intel.com>
> Subject: RE: [edk2] [PATCH 0/4] Coding style clean-up
> 
> Yes.  Please revert.
> 
> I am not sure I understand the ECC tool update you are suggesting.
> Can you provide more details?
> 
> Mike
> 
> > -----Original Message-----
> > From: Wang, Jian J
> > Sent: Tuesday, December 26, 2017 4:40 PM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-
> > devel@lists.01.org
> > Subject: RE: [edk2] [PATCH 0/4] Coding style clean-up
> >
> > Hi Mike,
> >
> > Since this patch has been checked in trunk, do you think
> > it should be reverted?
> > In addition, instead of using exception list for the ECC
> > tool, I think it'd be better
> > to update ECC tool to use keyword match to check if a
> > field name is public spec
> > defined one. Otherwise, if there's new structure type
> > using those field names,
> > the tool will still report errors.
> >
> > Regards,
> > Jian
> >
> > > -----Original Message-----
> > > From: Kinney, Michael D
> > > Sent: Wednesday, December 27, 2017 12:48 AM
> > > To: Wang, Jian J <jian.j.wang@intel.com>; edk2-
> > devel@lists.01.org; Kinney,
> > > Michael D <michael.d.kinney@intel.com>
> > > Subject: RE: [edk2] [PATCH 0/4] Coding style clean-up
> > >
> > > Jian,
> > >
> > > I do not think this change should be made.
> > >
> > > One of the exceptions for not following the
> > > EDK II code style is if the field names are
> > > defined in a public specification.  In this case
> > > these fields are all listed in a structure in
> > > the Intel 64 and IA-32 Architectures Software
> > > Development Manual, Section 7.2.1, Figure 7-2
> > > using upper case register names.
> > >
> > > Thanks,
> > >
> > > Mike
> > >
> > >
> > >
> > > > -----Original Message-----
> > > > From: edk2-devel [mailto:edk2-devel-
> > bounces@lists.01.org]
> > > > On Behalf Of Jian J Wang
> > > > Sent: Sunday, December 24, 2017 5:07 PM
> > > > To: edk2-devel@lists.01.org
> > > > Subject: [edk2] [PATCH 0/4] Coding style clean-up
> > > >
> > > > This patch series are meant for cleaning up code
> > > > according to coding style
> > > > requirements.
> > > >
> > > > Jian J Wang (4):
> > > >   MdePkg/BaseLib.h: Coding style clean-up
> > > >   MdeModulePkg/Core: Coding style clean-up
> > > >   UefiCpuPkg/UefiCpuPkg.uni: Add missing string
> > > > definition for new PCDs
> > > >   UefiCpuPkg: Update code to use new structure field
> > > > names
> > > >
> > > >  MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c   |
> > 5
> > > > ++
> > > >  MdePkg/Include/Library/BaseLib.h                   |
> > 72
> > > > +++++++++++-----------
> > > >  .../Ia32/ArchExceptionHandler.c                    |
> > 24
> > > > ++++----
> > > >  .../X64/ArchExceptionHandler.c                     |
> > 6
> > > > +-
> > > >  UefiCpuPkg/Library/MpInitLib/MpLib.c               |
> > 2
> > > > +-
> > > >  UefiCpuPkg/UefiCpuPkg.uni                          |
> > 16
> > > > ++++-
> > > >  6 files changed, 71 insertions(+), 54 deletions(-)
> > > >
> > > > --
> > > > 2.15.1.windows.2
> > > >
> > > > _______________________________________________
> > > > edk2-devel mailing list
> > > > edk2-devel@lists.01.org
> > > > https://lists.01.org/mailman/listinfo/edk2-devel