From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 4310421951C8C for ; Tue, 25 Apr 2017 23:56:57 -0700 (PDT) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 25 Apr 2017 23:56:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.37,253,1488873600"; d="scan'208";a="1140266269" Received: from mdkinney-mobl.amr.corp.intel.com ([10.255.230.13]) by fmsmga001.fm.intel.com with ESMTP; 25 Apr 2017 23:56:56 -0700 From: Michael Kinney To: edk2-devel@lists.01.org Cc: Liming Gao , Yonghong Zhu , Kevin W Shaw Date: Tue, 25 Apr 2017 23:56:51 -0700 Message-Id: <1493189812-10248-2-git-send-email-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.6.3.windows.1 In-Reply-To: <1493189812-10248-1-git-send-email-michael.d.kinney@intel.com> References: <1493189812-10248-1-git-send-email-michael.d.kinney@intel.com> Subject: [edk2-BuildSpecification PATCH V2 1/2] Clean up minor formatting issues X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 26 Apr 2017 06:56:57 -0000 Cc: Liming Gao Cc: Yonghong Zhu Cc: Kevin W Shaw Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael Kinney --- .../43_pre-build_stage_overview.md | 22 ++++++++++------------ .../45_post-build_stage.md | 12 ++++++------ .../82_auto-generation_process.md | 2 +- .../87_generated_asbuilt_inf_files.md | 2 +- 4 files changed, 18 insertions(+), 20 deletions(-) diff --git a/4_edk_ii_build_process_overview/43_pre-build_stage_overview.md b/4_edk_ii_build_process_overview/43_pre-build_stage_overview.md index 30177a8..0fde612 100644 --- a/4_edk_ii_build_process_overview/43_pre-build_stage_overview.md +++ b/4_edk_ii_build_process_overview/43_pre-build_stage_overview.md @@ -250,21 +250,19 @@ directory name and the `BASE_NAME` of the module's INF file. * Create the module Makefiles - Individual modules may require different compilation options, over-riding any - global definitions. If an INF file is not listed in the DSC file and is listed - in the FDF file, the parsing tools must check if the INF in the FDF file - contains `PatchableInModule` or `DynamicEX` entries. If the INF lists other PCD - access methods (FeatureFlag, - - FixedAtBuild or Dynamic), and the INF contains files listed in a `[Sources]` - section and does not contain a `[Binaries]` section, then the build tools must - break the build with an appropriate error message. + Individual modules may require different compilation options, over-riding + any global definitions. If an INF file is not listed in the DSC file and is + listed in the FDF file, the parsing tools must check if the INF in the FDF + file contains `PatchableInModule` or `DynamicEX` entries. If the INF lists + other PCD access methods (FeatureFlag, FixedAtBuild or Dynamic), and the INF + contains files listed in a `[Sources]` section and does not contain a + `[Binaries]` section, then the build tools must break the build with an + appropriate error message. 6. The tools are also responsible for creating binary files containing all `DynamicEx` PCDs that are listed in the DSC, FDF and Binary INF files - (listed in the FDF file). - These binaries are automatically placed into the (PEIM and DXE) PCD driver FFS - files. + (listed in the FDF file). These binaries are automatically placed into the + (PEIM and DXE) PCD driver FFS files. 7. If the build option, --ignore-sources is present on the build command-line, none of the source files listed in a [Sources] section will be processed, diff --git a/4_edk_ii_build_process_overview/45_post-build_stage.md b/4_edk_ii_build_process_overview/45_post-build_stage.md index c8a90e1..c35d9be 100644 --- a/4_edk_ii_build_process_overview/45_post-build_stage.md +++ b/4_edk_ii_build_process_overview/45_post-build_stage.md @@ -64,12 +64,12 @@ following must occur. that entry must be ignored - these files are not to be placed into an `EFI_SECTION_DISPOSABLE` encapsulation section. -2. If an INF not listed in the DSC file. is listed in the FDF file and the INF - contains a `[PatchPcd]` section, the tools must test to determine if the PCD - is listed in the DSC (or FDF) file, and whether the value listed in the DSC - (or FDF) file is different from the value in the INF file. If the value is - different, the tools must patch the binary .efi file with the value from the - FDF or DSC file prior to creating the EFI leaf section. +2. If an INF not listed in the DSC file, but is listed in the FDF file and the + INF contains a `[PatchPcd]` section, the tools must test to determine if the + PCD is listed in the DSC (or FDF) file, and whether the value listed in the + DSC (or FDF) file is different from the value in the INF file. If the value + is different, the tools must patch the binary .efi file with the value from + the FDF or DSC file prior to creating the EFI leaf section. 3. The tools are also responsible for creating binary files containing all DynamicEx PCDs that are listed in the DSC, FDF and Binary INF files (listed diff --git a/8_pre-build_autogen_stage/82_auto-generation_process.md b/8_pre-build_autogen_stage/82_auto-generation_process.md index 6868d62..92b6d99 100644 --- a/8_pre-build_autogen_stage/82_auto-generation_process.md +++ b/8_pre-build_autogen_stage/82_auto-generation_process.md @@ -772,7 +772,7 @@ that is unique to the GUID known as the TokenSpaceGuidCName. The following list defines the five PCD access methods. -* **FeatureFlag PCD**; used in conditional directive statements in code. +* **FeatureFlag PCD** - used in conditional directive statements in code. * **PatchableInModule PCD** - a volatile variable that can be updated either during a build or by a tool that knows the offset and data size of the diff --git a/8_pre-build_autogen_stage/87_generated_asbuilt_inf_files.md b/8_pre-build_autogen_stage/87_generated_asbuilt_inf_files.md index 9e89d83..0f39879 100644 --- a/8_pre-build_autogen_stage/87_generated_asbuilt_inf_files.md +++ b/8_pre-build_autogen_stage/87_generated_asbuilt_inf_files.md @@ -431,7 +431,7 @@ For ACPI files from a platform, the entry must use the following format: ` ACPI|Filename.acpi ` -For a Binary or raw binary file, the entry may use either of the the following +For a Binary or raw binary file, the entry may use either of the following two formats: ``` -- 2.6.3.windows.1