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

["Sunil V L" <sunilvl@ventanamicro.com>]

Hi Abner,

Just few minor comments below. Otherwise,

Acked-by: Sunil V L <sunilvl@ventanamicro.com>


On Sat, Oct 15, 2022 at 07:47:57PM +0800, abner.chang@amd.com wrote:
> From: Abner Chang <abner.chang@amd.com>
> 
> Updates 4.2 Directory names and 4.3 file names for
> the guidelines of module directory and file naming.
> 
> PR: https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification/pull/2/files
> 
> Signed-off-by: Abner Chang <abner.chang@amd.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Sunil V L <sunilvl@ventanamicro.com>
> Cc: Abdul Lateef Attar <abdattar@amd.com>
> Cc: Leif Lindholm <quic_llindhol@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