[edk2-devel] [tianocore-docs][PATCH V2 2/2] edk II C Coding Standard: Updates 4.2 and 4.3 sections

[Chang, Abner via groups.io]

[AMD Official Use Only - General]

Just fixed they all. Will send out the next version. Thanks Sunil.

Abner

> -----Original Message-----
> From: Sunil V L <sunilvl at ventanamicro.com>
> Sent: Tuesday, October 18, 2022 9:34 PM
> To: Chang, Abner <Abner.Chang at amd.com>
> Cc: devel at edk2.groups.io; Ray Ni <ray.ni at intel.com>; Michael D Kinney
> <michael.d.kinney at intel.com>; Attar, AbdulLateef (Abdul Lateef)
> <AbdulLateef.Attar at amd.com>; Leif Lindholm <quic_llindhol at quicinc.com>
> Subject: Re: [tianocore-docs][PATCH V2 2/2] edk II C Coding Standard:
> Updates 4.2 and 4.3 sections
> 
> Caution: This message originated from an External Source. Use proper
> caution when opening attachments, clicking links, or responding.
> 
> 
> Hi Abner,
> 
> Just few minor comments below. Otherwise,
> 
> Acked-by: Sunil V L <sunilvl at ventanamicro.com>
> 
> 
> On Sat, Oct 15, 2022 at 07:47:57PM +0800, abner.chang at amd.com wrote:
> > From: Abner Chang <abner.chang at amd.com>
> >
> > Updates 4.2 Directory names and 4.3 file names for the guidelines of
> > module directory and file naming.
> >
> > PR:
> >
> https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgith
> > ub.com%2Ftianocore-docs%2Fedk2-
> CCodingStandardsSpecification%2Fpull%2F
> >
> 2%2Ffiles&data=05%7C01%7Cabner.chang%40amd.com%7C61ac30c1dc
> 764eb57
> >
> cd708dab10d67d2%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C6
> 38016968
> >
> 393253054%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIj
> oiV2luMzIi
> >
> LCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=4OFcJ
> qJ%2FNVV
> > KwYFDxe%2BASxPZGmMj8VchZE1%2BLF03LXQ%3D&reserved=0
> >
> > Signed-off-by: Abner Chang <abner.chang at amd.com>
> > Cc: Ray Ni <ray.ni at intel.com>
> > Cc: Michael D Kinney <michael.d.kinney at intel.com>
> > Cc: Sunil V L <sunilvl at ventanamicro.com>
> > Cc: Abdul Lateef Attar <abdattar at amd.com>
> > Cc: Leif Lindholm <quic_llindhol at quicinc.com>
> > ---
> >  4_naming_conventions/42_directory_names.md | 101
> +++++++++++++++++++
> >  4_naming_conventions/43_file_names.md      | 108
> ++++++++++++++++++++-
> >  2 files changed, 208 insertions(+), 1 deletion(-)
> >
> > diff --git a/4_naming_conventions/42_directory_names.md
> > b/4_naming_conventions/42_directory_names.md
> > index 766ccb1..959a3c9 100644
> > --- a/4_naming_conventions/42_directory_names.md
> > +++ b/4_naming_conventions/42_directory_names.md
> > @@ -2,6 +2,7 @@
> >    4.2 Directory Names
> >
> >    Copyright (C) 2022 Advanced Micro Devices, Inc. All rights
> > reserved.<BR>
> > +  Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
> >
> >    Redistribution and use in source (original document form) and 'compiled'
> >    forms (converted to PDF, epub, HTML and other formats) with or
> > without @@ -28,3 +29,103 @@
> >    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
> >
> >  -->
> > +
> > +## 4.2 Directory Names
> > +Below sections are the directory naming guidelines for EDK II
> > +modules. The guidelines are not just considering the the uniformity
> > +of directory naming, but it also provides the flexibility of
>                         ^ An extra "the".
> 
> "it also provides" -> "they also provide" ?
> 
> > +directory name construction for the scenario of different EDK II
> > +module designs; such as the support for multiple processor
> > +architectures and vendors. It may require the further discussions
> 
> "the further" -> further
> 
> > +between EDK II maintainers and contributors in order to determine the
> > +best naming of the EDK II
>                                                ^ remove "in order" ?
> > +module directory.
> > +
> > +#### 4.2.1 EDKII package directory
> > +
> > +```
> > +<PackageName>Pkg
> > +
> > +   <PackageName> REQUIRED  *
> > +```
> > +
> > +#### 4.2.2 EDKII Module directory
> > +
> > +* The guideline below is applied to all CPU architectures support, specific
> CPU architecture and vendors support, or the implementation is shared by
> certain CPU archs:
> 
> Better to use architectures instead of "archs" ?
> 
> Thanks
> Sunil


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