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

["Michael D Kinney" <michael.d.kinney@intel.com>]

We do not want to do another global reformat for column width change.

What does Uncristify do now?  We need to make sure spec matches current behavior.

I added Michael Kubacki to this thread earlier so he can provide the details.


Mike

> -----Original Message-----
> From: Chang, Abner <Abner.Chang@amd.com>
> Sent: Saturday, November 12, 2022 5:37 PM
> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>; Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Wee, Sing <sing.wee@microsoft.com>; Rebecca Cran <rebecca@quicinc.com>; lersek@redhat.com; heyi.guo@linaro.org
> Subject: RE: [edk2-devel] [edk2-CCodingStandardsSpecification] Create release/2.30 branch
> 
> [AMD Official Use Only - General]
> 
> Yes Mike, we can merge the patch 1/2 for the line in 80 columns topic. Not sure if Uncrustify is smart enough to correct the
> existing code that have the line with column > 80, especially for the postfix comment that makes the line has  > 80 columns. Or
> we just leave the code there.
> 
> But for the patch 2/2: The multi line function (https://edk2.groups.io/g/devel/topic/30907266#13206), there is no conclusion yet
> however I think we can fix it in CCS v2.3.
> My reply is here: https://edk2.groups.io/g/devel/message/96324
> 
> Thanks
> Abner
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
> > D Kinney via groups.io
> > Sent: Tuesday, November 8, 2022 1:07 AM
> > To: Chang, Abner <Abner.Chang@amd.com>; devel@edk2.groups.io;
> > Michael Kubacki <mikuback@linux.microsoft.com>; Kinney, Michael D
> > <michael.d.kinney@intel.com>
> > Cc: Wee, Sing <sing.wee@microsoft.com>; Rebecca Cran
> > <rebecca@quicinc.com>; lersek@redhat.com; heyi.guo@linaro.org
> > 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,
> >
> > 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://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugz
> > illa.tianocore.org%2Fshow_bug.cgi%3Fid%3D713&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=D69iyxD8b723VL
> > 9I2okQHPr%2FTILymNgLR1%2BC9zdeKXE%3D&amp;reserved=0 - Update
> > EDK II C Coding standard to state a stronger preference for 80 column line
> > widths
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugz
> > illa.tianocore.org%2Fshow_bug.cgi%3Fid%3D714&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=iytS8GVsHwWl8
> > oLHM4C0IKemmVp5Y9qyPrcGD5kehRw%3D&amp;reserved=0 - 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://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fedk
> > 2.groups.io%2Fg%2Fdevel%2Fmessage%2F13204&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=8wsQDvWYYEag
> > M3u8zHTGiladwgosQ%2BUAyQVByqnqstU%3D&amp;reserved=0
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fedk
> > 2.groups.io%2Fg%2Fdevel%2Fmessage%2F13205&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=qg06y6ulcsV67iiT
> > VLO081VAm2mFw0CA49djt3SmwxQ%3D&amp;reserved=0
> >         Leif provide a Reviewed-by:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fedk
> > 2.groups.io%2Fg%2Fdevel%2Fmessage%2F13228&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=PwYZPFfScXiZcX
> > akiqSM%2BEGoIY2ay8KyVPQ0cYkf8h8%3D&amp;reserved=0
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fedk
> > 2.groups.io%2Fg%2Fdevel%2Fmessage%2F13206&amp;data=05%7C01%7Cab
> > ner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e28499%7C3dd8961
> > fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CUnkno
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=bPuRMrDPRm2
> > %2Fr3ahPJ8tsb78xQ1QowIbKGb2Nj3A5ME%3D&amp;reserved=0
> >         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://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgith
> > ub.com%2Flersek%2Fedk2-
> > CCodingStandardsSpecification%2Fcommit%2F2c5534a24b15616fdaa0247885
> > 8ed1d8908dc653&amp;data=05%7C01%7Cabner.chang%40amd.com%7Cc310
> > 1043683346dc8bac08dac0e28499%7C3dd8961fe4884e608e11a82d994e183d%
> > 7C0%7C0%7C638034376370079115%7CUnknown%7CTWFpbGZsb3d8eyJWIjoi
> > MC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C300
> > 0%7C%7C%7C&amp;sdata=w8LngdyWH5fu1dhszkdgMmkWBkXq3tF9nvgN0z
> > SYqVw%3D&amp;reserved=0
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgith
> > ub.com%2Flersek%2Fedk2-
> > CCodingStandardsSpecification%2Fcommit%2Fe3797dc48316052005cefa2624
> > 6ab2fd32641881&amp;data=05%7C01%7Cabner.chang%40amd.com%7Cc310
> > 1043683346dc8bac08dac0e28499%7C3dd8961fe4884e608e11a82d994e183d%
> > 7C0%7C0%7C638034376370079115%7CUnknown%7CTWFpbGZsb3d8eyJWIjoi
> > MC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C300
> > 0%7C%7C%7C&amp;sdata=RUnEumRPpYd7%2Fl9ENVu6g7KeyscFZnMjN%2B
> > Zeb7S9b9E%3D&amp;reserved=0
> >
> > Best regards,
> >
> > Mike
> >
> > > -----Original Message-----
> > > From: Chang, Abner <Abner.Chang@amd.com>
> > > Sent: Monday, November 7, 2022 6:18 AM
> > > To: Kinney, Michael D <michael.d.kinney@intel.com>;
> > > devel@edk2.groups.io
> > > Cc: Wee, Sing <sing.wee@microsoft.com>; Rebecca Cran
> > > <rebecca@quicinc.com>; lersek@redhat.com; heyi.guo@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@intel.com>;
> > > > devel@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@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@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@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@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
> > >
> > >
> > https://nam11.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmid.
> > m
> > > ail-archive.com%2F20170811164851.9466-1-
> > lersek%40redhat.com&amp;data=0
> > >
> > 5%7C01%7Cabner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e284
> > 99%7C3d
> > >
> > d8961fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CU
> > nknown%
> > >
> > 7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haW
> > wiLCJX
> > >
> > VCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=RtbRn2cTrhwUvlFxjWP7bEg
> > o7gnGR8R9v
> > > EKSe65RXEg%3D&amp;reserved=0
> > >
> > https://nam11.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmid.
> > m
> > > ail-archive.com%2F20170811164851.9466-2-
> > lersek%40redhat.com&amp;data=0
> > >
> > 5%7C01%7Cabner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e284
> > 99%7C3d
> > >
> > d8961fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CU
> > nknown%
> > >
> > 7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haW
> > wiLCJX
> > >
> > VCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=q7qLZjyr6IUpYtNraPlZKQJvB
> > ekm11v%2
> > > FkJbztxA76eI%3D&amp;reserved=0
> > >
> > https://nam11.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmid.
> > m
> > > ail-archive.com%2F20170811164851.9466-3-
> > lersek%40redhat.com&amp;data=0
> > >
> > 5%7C01%7Cabner.chang%40amd.com%7Cc3101043683346dc8bac08dac0e284
> > 99%7C3d
> > >
> > d8961fe4884e608e11a82d994e183d%7C0%7C0%7C638034376370079115%7CU
> > nknown%
> > >
> > 7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haW
> > wiLCJX
> > >
> > VCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=M0sZmbstyxn7iWay996bjUJ
> > maBqblRFNr
> > > 52P6JCOOhk%3D&amp;reserved=0
> > >
> > > > 2664        EDK2    Document        michael.d.kinney@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@intel.com>
> > > > > Sent: Friday, October 28, 2022 11:22 PM
> > > > > To: devel@edk2.groups.io; Chang, Abner <Abner.Chang@amd.com>;
> > > > Kinney,
> > > > > Michael D <michael.d.kinney@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@edk2.groups.io <devel@edk2.groups.io> On Behalf Of
> > > > > > Chang, Abner via groups.io
> > > > > > Sent: Thursday, October 27, 2022 9:54 AM
> > > > > > To: devel@edk2.groups.io
> > > > > > Cc: Abner Chang <abner.chang@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@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
> > > > > >
> > > > > >
> > > > > >
> > > > > >
> > > > > >
> >
> >
> > 
> >