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

["Chang, Abner" <abner.chang@amd.com>]

[-- Attachment #1: Type: text/plain, Size: 1999 bytes --]

[AMD Official Use Only - General]

Hi Ray,

<CpuArch>][<Vendor>]<FileName>.*

The simple <FileName> naming rule was already  defined in the 4.3.1 to 4.3.4 sections. We are not intending for defining the file naming style. This section is mainly for the format of attaching <CpuArch> and <Vendor> to the filename.
For example, how do we add AMD to SmmCpuFeaturesLib? Is "Amd"SmmCpuFeaturesLib or SmmCpuFeaturesLib"Amd"? This is what we would like to define for the processor archs and vendors.
My opinion is we can just leave the file format naming as it was defined in this spec.

Or how about if we say "Refer to 4.3.1 to 4.3.4 sections for the file naming format" for <FileNmae> in below?

[<CpuArch>][<Vendor>]<FileName>.*

   <CpuArch>   OPTIONAL   The <CpuArch> is represented with a BNF,
                          <arch> ::='Ia32' | 'X64' | 'Arm' | 'AArch64' | 'RiscV64' |
                                    'LoongArch64' | 'Ebc'
                          <CpuArch> ::= <arch>[<arch>]*

                          Example: Ia32X64Arm or RiscV64LoongArch64
   <Vendor>    OPTIONAL   *
   <FileName>  REQUIRED   Refer to 4.3.1 to 4.3.4 sections for the file
                          Naming format.

Thanks
Abner

From: Ni, Ray <ray.ni@intel.com>
Sent: Tuesday, October 18, 2022 2:02 PM
To: Chang; Chang, Abner <Abner.Chang@amd.com>; devel@edk2.groups.io
Subject: Re: [edk2-devel] [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.


All look good to me. Thanks for addressing my comments regarding simplifying the rules.

Except for one minor comment: I still don't think we need to define rules for source file names (4.3.5.4 EDK II source files within a Library/Module instance). And the rule "[][].*" doesn't specify what could be. That leads to allowing any style of the file name.

[-- Attachment #2: Type: text/html, Size: 8515 bytes --]