[edk2-devel] [PATCH] edk II C Coding Standard: Fix the formating issue

Chang, Abner via groups.io posted 1 patch 2 weeks, 2 days ago
Failed in applying to current master (apply log)
4_naming_conventions/42_directory_names.md | 5 +++--
4_naming_conventions/43_file_names.md      | 5 +++--
2 files changed, 6 insertions(+), 4 deletions(-)
[edk2-devel] [PATCH] edk II C Coding Standard: Fix the formating issue
Posted by Chang, Abner via groups.io 2 weeks, 2 days ago
From: Abner Chang <abner.chang@amd.com>

Fix the Markdown file to PDF formating issue.

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>
---
 4_naming_conventions/42_directory_names.md | 5 +++--
 4_naming_conventions/43_file_names.md      | 5 +++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/4_naming_conventions/42_directory_names.md b/4_naming_conventions/42_directory_names.md
index c590f64..df81d62 100644
--- a/4_naming_conventions/42_directory_names.md
+++ b/4_naming_conventions/42_directory_names.md
@@ -49,6 +49,7 @@ module directory.
 #### 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:
+
 ```
 <Feature><Phase>[<CpuArch>[<Vendor>]]
   or
@@ -63,7 +64,6 @@ module directory.
                               <CpuArch> ::= <arch>[<arch>]*
                               
                               Example: Ia32X64Arm or RiscV64LoongArch64
-                              
    <Vendor>       OPTIONAL    *
 
 Example:
@@ -98,7 +98,8 @@ Example:
    Pcd/Dxe/
 ```
 
-#### 4.2.2 EDKII Library directory
+#### 4.2.3 EDKII Library directory
+
 ```
 <Phase>[<CpuArch>[<Vendor>]]<LibraryClassName>[<Dependency>]
   or
diff --git a/4_naming_conventions/43_file_names.md b/4_naming_conventions/43_file_names.md
index 633c9ff..771b173 100644
--- a/4_naming_conventions/43_file_names.md
+++ b/4_naming_conventions/43_file_names.md
@@ -80,6 +80,7 @@ naming of the EDK II module file.
 
 #### 4.3.5.2 EDK II INF file within a Module instance
 * If the implementation is for all CPU architectures, specific CPU architectures, CPU vendors or the implementation is shared by certain CPU archs:
+
 ```
 <Feature><Phase>[<CpuArch>][<Vendor>].inf
 
@@ -120,6 +121,7 @@ Example:
 ```
 
 #### 4.3.5.3 EDK II INF file within a Library instance
+
 ```
 <Phase>[<CpuArch>][<Vendor>]<LibraryClassName>[<Dependency>].inf
    <Phase>              REQUIRED     Base, Sec, Pei, Dxe, DxeRuntime, Mm,
@@ -143,8 +145,8 @@ Example:
 #### 4.3.5.4 EDK II source files within a Library/Module instance
 
 In generally, the file name is constructed as below:
-```
 
+```
 [<CpuArch>][<Vendor>]<FileName>.*
 
    <CpuArch>   OPTIONAL   The <CpuArch> is represented with a BNF,
@@ -163,5 +165,4 @@ Example:
    Ia32X64SmmCpuFeaturesLib.c
    Ia32X64IntelSmmCpuFeaturesLib.c
    AmdSmmCpuFeaturesLib.c
-
 ```
\ No newline at end of file
-- 
2.37.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#96475): https://edk2.groups.io/g/devel/message/96475
Mute This Topic: https://groups.io/mt/95104021/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH] edk II C Coding Standard: Fix the formating issue
Posted by Michael D Kinney 2 weeks, 2 days ago
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>



> -----Original Message-----
> From: abner.chang@amd.com <abner.chang@amd.com>
> Sent: Thursday, November 17, 2022 5:31 PM
> To: devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>
> Subject: [PATCH] edk II C Coding Standard: Fix the formating issue
> 
> From: Abner Chang <abner.chang@amd.com>
> 
> Fix the Markdown file to PDF formating issue.
> 
> 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>
> ---
>  4_naming_conventions/42_directory_names.md | 5 +++--
>  4_naming_conventions/43_file_names.md      | 5 +++--
>  2 files changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/4_naming_conventions/42_directory_names.md b/4_naming_conventions/42_directory_names.md
> index c590f64..df81d62 100644
> --- a/4_naming_conventions/42_directory_names.md
> +++ b/4_naming_conventions/42_directory_names.md
> @@ -49,6 +49,7 @@ module directory.
>  #### 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:
> +
>  ```
>  <Feature><Phase>[<CpuArch>[<Vendor>]]
>    or
> @@ -63,7 +64,6 @@ module directory.
>                                <CpuArch> ::= <arch>[<arch>]*
> 
>                                Example: Ia32X64Arm or RiscV64LoongArch64
> -
>     <Vendor>       OPTIONAL    *
> 
>  Example:
> @@ -98,7 +98,8 @@ Example:
>     Pcd/Dxe/
>  ```
> 
> -#### 4.2.2 EDKII Library directory
> +#### 4.2.3 EDKII Library directory
> +
>  ```
>  <Phase>[<CpuArch>[<Vendor>]]<LibraryClassName>[<Dependency>]
>    or
> diff --git a/4_naming_conventions/43_file_names.md b/4_naming_conventions/43_file_names.md
> index 633c9ff..771b173 100644
> --- a/4_naming_conventions/43_file_names.md
> +++ b/4_naming_conventions/43_file_names.md
> @@ -80,6 +80,7 @@ naming of the EDK II module file.
> 
>  #### 4.3.5.2 EDK II INF file within a Module instance
>  * If the implementation is for all CPU architectures, specific CPU architectures, CPU vendors or the implementation is shared
> by certain CPU archs:
> +
>  ```
>  <Feature><Phase>[<CpuArch>][<Vendor>].inf
> 
> @@ -120,6 +121,7 @@ Example:
>  ```
> 
>  #### 4.3.5.3 EDK II INF file within a Library instance
> +
>  ```
>  <Phase>[<CpuArch>][<Vendor>]<LibraryClassName>[<Dependency>].inf
>     <Phase>              REQUIRED     Base, Sec, Pei, Dxe, DxeRuntime, Mm,
> @@ -143,8 +145,8 @@ Example:
>  #### 4.3.5.4 EDK II source files within a Library/Module instance
> 
>  In generally, the file name is constructed as below:
> -```
> 
> +```
>  [<CpuArch>][<Vendor>]<FileName>.*
> 
>     <CpuArch>   OPTIONAL   The <CpuArch> is represented with a BNF,
> @@ -163,5 +165,4 @@ Example:
>     Ia32X64SmmCpuFeaturesLib.c
>     Ia32X64IntelSmmCpuFeaturesLib.c
>     AmdSmmCpuFeaturesLib.c
> -
>  ```
> \ No newline at end of file
> --
> 2.37.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#96476): https://edk2.groups.io/g/devel/message/96476
Mute This Topic: https://groups.io/mt/95104021/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-