Re: [edk2] [Patch V2] INF spec: Correct some items in the Table 1 EDK II [Defines] Section

2018-09-12 Thread Gao, Liming
Reviewed-by: Liming Gao 

> -Original Message-
> From: Zhu, Yonghong
> Sent: Wednesday, September 12, 2018 8:45 PM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming ; Kinney, Michael D 
> ; Shaw, Kevin W 
> Subject: [Patch V2] INF spec: Correct some items in the Table 1 EDK II 
> [Defines] Section
> 
> V2: list the updated items
> Remove 'EDK_RELEASE_VERSION', 'DEFINE'
> Add 'PCI_REVISION'
> Update 'VERSION_STRING''s required attrubute in the table to Optional.
> Update 'LIBRARY_CLASS' and UEFI PCI Option ROM's value in the table per 3.4 
> section
> Update the table's format because current in the PDF format spec this table's
>   display was cut off.
> 
> Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=1162
> Cc: Liming Gao 
> Cc: Michael Kinney 
> Cc: Kevin W Shaw 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Yonghong Zhu 
> ---
>  2_inf_overview/24_[defines]_section.md   | 59 
> 
>  3_edk_ii_inf_file_format/34_[defines]_section.md |  2 +-
>  README.md|  1 +
>  3 files changed, 31 insertions(+), 31 deletions(-)
> 
> diff --git a/2_inf_overview/24_[defines]_section.md 
> b/2_inf_overview/24_[defines]_section.md
> index 37b0135..0afdfed 100644
> --- a/2_inf_overview/24_[defines]_section.md
> +++ b/2_inf_overview/24_[defines]_section.md
> @@ -106,35 +106,34 @@ the PEI Core or the Dxe Core. EDK II only references 
> the first possible
>  dispatch instance.
>  **
> 
>  ## Table 1 EDK II [Defines] Section Elements
> 
> -| Tag  | Required
>  | Value
> | Notes
> |
> -|  | 
>  | 
> - |
> -
> -
> -
>  |
> -| `INF_VERSION`| REQUIRED
>  | 1.27
> or 0x0001001B| This identifies the INF spec. 
> version. It is decimal value with fraction or two-nibble
> hexadecimal representation of the same, for example: 1.27. Tools use this 
> value to handle parsing of previous releases of the
> specification if there are incompatible changes.
> |
> -| `BASE_NAME`  | REQUIRED
>  | A
> single word | This is a single word 
> identifier that will be used for the component name.
> |
> -| `EDK_RELEASE_VERSION`| Not required
>  | Hex
> Double Word   | The minimum revision value across 
> the module and all its dependent libraries. If a
> revision value is not declared in the module or any of the dependent 
> libraries, then the tool may use the value of 0, which disables
> checking.
> |
> -| `PI_SPECIFICATION_VERSION`   | Not required
>  | Decimal
> or special format of hex  | The minimum revision value across the 
> module and all its dependent libraries. If a revision
> value is not declared in the module or any of the dependent libraries, then 
> tools may use the value of 0, which disables checking.
> |
> -|  | 
>  |
> | The `PI_SPECIFICATION_VERSION` must only be set in the INF file if the 
> module depends on services or system table fields or PI core
> behaviors that are not present in the PI 1.0 version. For example, if a 
> module depends on definitions in PI 1.1 that are not in PI 1.0, then
> `PI_SPECIFICATION_VERSION` must be 0x0001000A
> |
> -| `UEFI_SPECIFICATION_VERSION` | Not required
>  | Decimal
> or special format of hex  | The minimum revision value across the 
> module and all its dependent libraries. If a revision
> value is not declared in the module or any of the dependent libraries, then 
> tools may use the value of 0, which disables checking.
> |
> -|  | 
>  |
> | The `UEFI_SPECIFICATION_VERSIon` must only be set in the INF file if the 
> module depends on UEFI Boot Services or UEFI Runtime
> Services or UEFI System Table fields or UEFI core behaviors that are not 
> present in the UEFI 2.1 

[edk2] [Patch V2] INF spec: Correct some items in the Table 1 EDK II [Defines] Section

2018-09-12 Thread Yonghong Zhu
V2: list the updated items
Remove 'EDK_RELEASE_VERSION', 'DEFINE'
Add 'PCI_REVISION'
Update 'VERSION_STRING''s required attrubute in the table to Optional.
Update 'LIBRARY_CLASS' and UEFI PCI Option ROM's value in the table per 3.4 
section
Update the table's format because current in the PDF format spec this table's 
  display was cut off.
 
Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=1162
Cc: Liming Gao 
Cc: Michael Kinney 
Cc: Kevin W Shaw 
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Yonghong Zhu 
---
 2_inf_overview/24_[defines]_section.md   | 59 
 3_edk_ii_inf_file_format/34_[defines]_section.md |  2 +-
 README.md|  1 +
 3 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/2_inf_overview/24_[defines]_section.md 
b/2_inf_overview/24_[defines]_section.md
index 37b0135..0afdfed 100644
--- a/2_inf_overview/24_[defines]_section.md
+++ b/2_inf_overview/24_[defines]_section.md
@@ -106,35 +106,34 @@ the PEI Core or the Dxe Core. EDK II only references the 
first possible
 dispatch instance.
 **
 
 ## Table 1 EDK II [Defines] Section Elements
 
-| Tag  | Required  
   | Value | 
Notes   




|
-|  | 
 | 
- | 
---
 |
-| `INF_VERSION`| REQUIRED  
   | 1.27 or 0x0001001B| 
This identifies the INF spec. version. It is decimal value with fraction or 
two-nibble hexadecimal representation of the same, for example: 1.27. Tools use 
this value to handle parsing of previous releases of the specification if there 
are incompatible changes.   


   |
-| `BASE_NAME`  | REQUIRED  
   | A single word | 
This is a single word identifier that will be used for the component name.  




|
-| `EDK_RELEASE_VERSION`| Not required  
   | Hex Double Word   | 
The minimum revision value across the module and all its dependent libraries. 
If a revision value is not declared in the module or any of the dependent 
libraries, then the tool may use the value of 0, which disables checking.   


|
-| `PI_SPECIFICATION_VERSION`   | Not required  
   | Decimal or special format of hex  | 
The minimum revision value across the module and all its dependent libraries. 
If a revision value is not declared in the module or any of the dependent 
libraries, then tools may use the value of 0, which disables checking.  


|
-|  |