[edk2-devel] [edk2-CCodingStandardsSpecification] Create release/2.30 branch

Michael D Kinney michael.d.kinney at intel.com
Mon Nov 7 17:07:03 UTC 2022


Hi Abner,

Thanks for the review.  I agree we should try to get a few more of these resolved for Version 2.3.

+Michael Kubacki for Uncrustify configuration settings discussion on the column width
and args per line in function call topics. We need to know what the current Uncrustify
configuration settings for these 2 topics. It would be better of the spec and the 
Uncrustify settings were aligned and for any changes going forward they are made to the 
spec and Uncrustify settings at the same time.

Details of these 2 topics are as follows:

* TianoCore BZ links:
    https://bugzilla.tianocore.org/show_bug.cgi?id=713 - Update EDK II C Coding standard to state a stronger preference for 80 column line widths
    https://bugzilla.tianocore.org/show_bug.cgi?id=714 - Update EDK II C Coding Standards to allow multiple arguments per line in a function call

* The patch emails and discussions are in groups.io:
    https://edk2.groups.io/g/devel/message/13204
    https://edk2.groups.io/g/devel/message/13205    
        Leif provide a Reviewed-by: https://edk2.groups.io/g/devel/message/13228
    https://edk2.groups.io/g/devel/message/13206
        There is a good discussion of this change with no Rb.

* The links to the formatted versions of the reviews are no longer working,
  but they can be view on GitHub in the branch Laszlo provided and select the
  "Display the rich diff" view of the markdown changes:
    https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/2c5534a24b15616fdaa02478858ed1d8908dc653
    https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/e3797dc48316052005cefa26246ab2fd32641881

Best regards,

Mike

> -----Original Message-----
> From: Chang, Abner <Abner.Chang at amd.com>
> Sent: Monday, November 7, 2022 6:18 AM
> To: Kinney, Michael D <michael.d.kinney at intel.com>; devel at edk2.groups.io
> Cc: Wee, Sing <sing.wee at microsoft.com>; Rebecca Cran <rebecca at quicinc.com>; lersek at redhat.com; heyi.guo at linaro.org
> Subject: RE: [edk2-devel] [edk2-CCodingStandardsSpecification] Create release/2.30 branch
> 
> [AMD Official Use Only - General]
> 
> Hi Mike,
> You probably missed this email. I checked the below C coding standard spec related BZ and had some comments in line below.
> 
> > -----Original Message-----
> > From: Chang, Abner
> > Sent: Saturday, October 29, 2022 11:33 AM
> > To: Kinney, Michael D <michael.d.kinney at intel.com>; devel at edk2.groups.io
> > Subject: RE: [edk2-devel] [edk2-CCodingStandardsSpecification] Create
> > release/2.30 branch
> >
> > [AMD Official Use Only - General]
> >
> > Hi Mike,
> > Below are the tickets pulled out from BZ, is there any one you think is not
> > necessary now?
> > Abner
> >
> > 713	EDK2	Document	michael.d.kinney at intel.com	CONF	---
> > 	Update EDK II C Coding standard to state a stronger preference for 80
> > column line widths	2021-07-27
> Seems no conclusion from the discussion in BZ.
> 
> > 1766	EDK2	Document	michael.d.kinney at intel.com	CONF	---
> > 	Remove use of STATIC macros from EDK II C Coding Standard
> > Specification	2020-12-09
> No conclusion yet.
> 
> > 1698	EDK2	Document	michael.d.kinney at intel.com	CONF	---
> > 	Spurious rule about comment style in CCS 6.2.3	2021-07-27
> Had we addressed this issue on the coding standard spec yet? If not, we can fix this in the version 2.3.
> 
> > 714	EDK2	Document	michael.d.kinney at intel.com	CONF	---
> > 	Update EDK II C Coding Standards to allow multiple arguments per
> > line in a function call	2021-07-27
> Have these patches been reviewed?
> [edk2] [edk2-CCodingStandardsSpecification PATCH 0/2] improvements related to line wrapping
> [edk2] [edk2-CCodingStandardsSpecification PATCH 1/2] Source Files / General Rules: limit line lengths to 80 columns
> [edk2] [edk2-CCodingStandardsSpecification PATCH 2/2] Source Files / Spacing / Multi-line func. calls: allow condensed arguments
> 
> http://mid.mail-archive.com/20170811164851.9466-1-lersek@redhat.com
> http://mid.mail-archive.com/20170811164851.9466-2-lersek@redhat.com
> http://mid.mail-archive.com/20170811164851.9466-3-lersek@redhat.com
> 
> > 2664	EDK2	Document	michael.d.kinney at intel.com	CONF	---
> > 	Discrepancies/inconsistencies in coding standards, style and
> > examples          2021-10-02
> I think we can fix the above inconsistent issues in the version 2.3 release.
> 
> Thanks
> Abner
> 
> >
> > > -----Original Message-----
> > > From: Kinney, Michael D <michael.d.kinney at intel.com>
> > > Sent: Friday, October 28, 2022 11:22 PM
> > > To: devel at edk2.groups.io; Chang, Abner <Abner.Chang at amd.com>;
> > Kinney,
> > > Michael D <michael.d.kinney at intel.com>
> > > Subject: RE: [edk2-devel] [edk2-CCodingStandardsSpecification] Create
> > > release/2.30 branch
> > >
> > > Caution: This message originated from an External Source. Use proper
> > > caution when opening attachments, clicking links, or responding.
> > >
> > >
> > > Hi Abner,
> > >
> > > Have you reviewed the open BZs against the EDK II C Coding Standard.
> > >
> > > Are there any other issues that are considered important to fix before
> > > making a new official release?
> > >
> > > Thanks,
> > >
> > > Mike
> > >
> > > > -----Original Message-----
> > > > From: devel at edk2.groups.io <devel at edk2.groups.io> On Behalf Of
> > > > Chang, Abner via groups.io
> > > > Sent: Thursday, October 27, 2022 9:54 AM
> > > > To: devel at edk2.groups.io
> > > > Cc: Abner Chang <abner.chang at amd.com>
> > > > Subject: [edk2-devel] [edk2-CCodingStandardsSpecification] Create
> > > > release/2.30 branch
> > > >
> > > > Contributed-under: TianoCore Contribution Agreement 1.1
> > > > Signed-off-by: Abner Chang <abner.chang at amd.com>
> > > > ---
> > > >  book.json | 3 +--
> > > >  1 file changed, 1 insertion(+), 2 deletions(-)
> > > >
> > > > diff --git a/book.json b/book.json
> > > > index d112b26..1fdd570 100644
> > > > --- a/book.json
> > > > +++ b/book.json
> > > > @@ -1,8 +1,7 @@
> > > >  {
> > > >
> > > >    "variables" : {
> > > >
> > > > -    "draft"   : "yes",
> > > >
> > > >      "title"   : "EDK II C Coding Standards Specification",
> > > >
> > > > -    "version" : "Revision 2.2"
> > > >
> > > > +    "version" : "Revision 2.3"
> > > >
> > > >    },
> > > >
> > > >    "plugins": ["puml-aleung"],
> > > >
> > > >    "pluginsConfig": {}
> > > >
> > > > --
> > > > 2.37.1.windows.1
> > > >
> > > >
> > > >
> > > > 
> > > >


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#96038): https://edk2.groups.io/g/devel/message/96038
Mute This Topic: https://groups.io/mt/94608722/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-




More information about the edk2-devel-archive mailing list