[Patch] Build Spec: Add description for Structure Pcd display in the module

* [Patch] Build Spec: Add description for Structure Pcd display in the module
@ 2018-10-11  7:50 Yonghong Zhu
  2018-10-12 13:32 ` Gao, Liming
  0 siblings, 1 reply; 2+ messages in thread
From: Yonghong Zhu @ 2018-10-11  7:50 UTC (permalink / raw)
  To: edk2-devel; +Cc: Liming Gao, Michael Kinney, Kevin W Shaw

The detail rules are totally same with Global Pcd section.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
---
 13_build_reports/136_global_pcd_section.md | 12 ++++++------
 13_build_reports/138_module_section.md     |  7 ++-----
 2 files changed, 8 insertions(+), 11 deletions(-)

diff --git a/13_build_reports/136_global_pcd_section.md b/13_build_reports/136_global_pcd_section.md
index 0e3afa7..9a3b98e 100644
--- a/13_build_reports/136_global_pcd_section.md
+++ b/13_build_reports/136_global_pcd_section.md
@@ -160,23 +160,23 @@ option.
 #### 13.6.2.4 Rules for Structure PCD
 If the Pcd is a Structure Pcd, it display in the report file would have two parts.
 One is the final Pcd value and its field value, the field value is from FDF file,
 DSC file PCD Section or build option, not from the final structure byte array,
 and the field order is sorted by the field name. When the field value from DSC file
-PCD Section, it will not have additional *P Flag, when the field value from FDF file,
-it will have additional *F Flag before the field name, when the field value from
-build option, it will have additional *B Flag before the field name. The other part
+PCD Section, it will not have additional `*P` Flag, when the field value from FDF file,
+it will have additional `*F` Flag before the field name, when the field value from
+build option, it will have additional `*B` Flag before the field name. The other part
 is the DEC default value and its field value, this part is optional. The field value
 in this part is from DEC file, and the field order is sorted by the field name.
 
 **********
 **Note:** When the structure Pcd have some value from build option, no matter whether
-the value is same with FDF or DSC file or DEC file, there will display a *B Flag before
+the value is same with FDF or DSC file or DEC file, there will display a `*B` Flag before
 the PCD name. When the structure Pcd have some value from FDF file, no matter whether
-the value is same with DSC file or DEC file, there will display a *F Flag before the
+the value is same with DSC file or DEC file, there will display a `*F` Flag before the
 PCD name. When the structure Pcd value have some value from DSC file PCD section, no
-matter whether the value is same with DEC file, there will display a *P Flag before
+matter whether the value is same with DEC file, there will display a `*P` Flag before
 the PCD name.
 **********
 
 #### Example
 
diff --git a/13_build_reports/138_module_section.md b/13_build_reports/138_module_section.md
index 843ad34..d457c24 100644
--- a/13_build_reports/138_module_section.md
+++ b/13_build_reports/138_module_section.md
@@ -260,15 +260,12 @@ Each PCD may contain up to following lines:
    *P PcdPlatformBootTimeOut : DYNHII (UINT16) = 0xA (10)
                      gEfiGlobalVariableGuid: L"Timeout": 0x0
                                 DEC DEFAULT = 0xffff (65535)
    ```
 
-4. Additional lines may exist if the PCD is Structure PCD. Every field value
-that user specified in DSC/DEC file and build command will print out. The field
-value is from DSC/DEC file or build command, not from the final structure byte
-array, and the field order is same as it in DSC/DEC file. when the field value is
-from build command, tool will additional print a *B Flag.
+4. Additional lines may exist if the PCD is Structure PCD. Please refer to 
+13.6.2.4 Rules for Structure PCD for details.
 
 **********
 **Note:** This sub-section is present when **PCD** is specified in **-Y**
 option.
 **********
-- 
2.6.1.windows.1



^ permalink raw reply related	[flat|nested] 2+ messages in thread