Re: [Patch] FDF spec: Update version to 1.28

["Gao, Liming" <liming.gao@intel.com>]

Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: Zhu, Yonghong
>Sent: Tuesday, April 03, 2018 3:18 PM
>To: edk2-devel@lists.01.org
>Cc: Gao, Liming <liming.gao@intel.com>; Kinney, Michael D
><michael.d.kinney@intel.com>; Shaw, Kevin W <kevin.w.shaw@intel.com>
>Subject: [Patch] FDF spec: Update version to 1.28
>
>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>
>---
> 2_fdf_design_discussion/README.md                |  4 ++--
> 3_edk_ii_fdf_file_format/34_[defines]_section.md | 16 ++++++++--------
> README.md                                        |  5 +++--
> 3 files changed, 13 insertions(+), 12 deletions(-)
>
>diff --git a/2_fdf_design_discussion/README.md
>b/2_fdf_design_discussion/README.md
>index 3202f56..7d87e43 100644
>--- a/2_fdf_design_discussion/README.md
>+++ b/2_fdf_design_discussion/README.md
>@@ -1,9 +1,9 @@
> <!--- @file
>   2 FDF Design Discussion
>
>-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
>+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
>
>   Redistribution and use in source (original document form) and 'compiled'
>   forms (converted to PDF, epub, HTML and other formats) with or without
>   modification, are permitted provided that the following conditions are met:
>
>@@ -50,11 +50,11 @@ The EDK II Build generates UEFI and PI specification
>compliant binary images.
> The tools provided in the EDK and the EdkCompatibilityPkg module support
> earlier versions of the specifications.
>
> This revision of the specification adds support for multiple binary files in
> an FV FILE RAW statement. FDF files that use this feature must use the new
>-`FDF_SPECIFICATION = 0x0001001B` in the `[Defines]` section. Older FDF files
>+`FDF_SPECIFICATION = 0x0001001C` in the `[Defines]` section. Older FDF files
> do not need to update the `FDF_SPECIFICATION` value.
>
> The EDK II build system has been updated to allow the setting of multiple
>paths
> that will be searched when attempting to resolve the location of EDK II
> packages. This new feature allows for more flexibility when designing a tree
>diff --git a/3_edk_ii_fdf_file_format/34_[defines]_section.md
>b/3_edk_ii_fdf_file_format/34_[defines]_section.md
>index 5bbb890..83b0bbf 100644
>--- a/3_edk_ii_fdf_file_format/34_[defines]_section.md
>+++ b/3_edk_ii_fdf_file_format/34_[defines]_section.md
>@@ -1,9 +1,9 @@
> <!--- @file
>   3.4 [Defines] Section
>
>-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
>+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
>
>   Redistribution and use in source (original document form) and 'compiled'
>   forms (converted to PDF, epub, HTML and other formats) with or without
>   modification, are permitted provided that the following conditions are met:
>
>@@ -38,17 +38,17 @@ section following comment blocks at the beginning of
>the file.
>
> This section describes the defines section content in the FDF files. This file
> can be created by a developer and is an input to the EDK II build tool parsing
> utilities. Elements may appear in any order within this section.
>
>-The code for this version of the FDF specification is "0x0001001B". New
>-versions of this specification must increment the minor (001B) portion of the
>+The code for this version of the FDF specification is "0x0001001C". New
>+versions of this specification must increment the minor (001C) portion of the
> specification code for backward-compatible changes, and increment the
>major
> specification number for non-backward-compatible changes.
>
> This revision of the specification adds new features. Any FDF file that uses
>-these new features must use the value `0x0001001B` in the
>`FDF_SPECIFICATION`
>+these new features must use the value `0x0001001C` in the
>`FDF_SPECIFICATION`
> statement. Older FDF files that do not use these new feature do not need to
> update the value.
>
> Conditional statements may be used anywhere within this section.
>
>@@ -78,17 +78,17 @@ The version number for this flash definition; the value
>is not used by build
> tools, but the version element is provided for user tracking capabilities that
> may be used by other user interface tools.
>
> **_FDF_SPECIFICATION_**
>
>-For this specification, the version value is 0x0001001B. Tools that process
>+For this specification, the version value is 0x0001001C. Tools that process
> this version of the FDF file can successfully process earlier versions of the
> FDF files (this is a backward compatible update). If an FDF file with an
> earlier version of the `FDF_SPECIFICATION` is modified to use a feature
>added
>-in the 1.27 version of this specification must be updated to 0x0001001B.
>There
>+in the 1.28 version of this specification must be updated to 0x0001001C.
>There
> is no requirement to change existing entries if no other content changes. This
>-value may also be specified as decimal value, such as 1.27.
>+value may also be specified as decimal value, such as 1.28.
>
> **_PcdNames_**
>
> PCDs defined in this section take precedence over PCD values specified in
>other
> meta-data files. Note that PCDs defined via the SET statements in sub-
>sections
>@@ -97,9 +97,9 @@ meta-data files.
>
> #### Example
>
> ```ini
> [Defines]
>-  FDF_SPECIFICATION                          = 0x0001001B
>+  FDF_SPECIFICATION                          = 0x0001001C
>   DEFINE BIG_STUFF                           = False
>   SET gEfiMyPlatformTokenSpaceGuid.MyUsbFlag = True
> ```
>diff --git a/README.md b/README.md
>index 4e15a73..b4a04eb 100644
>--- a/README.md
>+++ b/README.md
>@@ -1,9 +1,9 @@
> <!--- @file
>   README.md for EDK II Flash Description (FDF) File Specification
>
>-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
>+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
>
>   Redistribution and use in source (original document form) and 'compiled'
>   forms (converted to PDF, epub, HTML and other formats) with or without
>   modification, are permitted provided that the following conditions are met:
>
>@@ -192,11 +192,11 @@ Copyright (c) 2006-2017, Intel Corporation. All rights
>reserved.
> |            | WORKSPACE directory tree (refer to the TianoCore.org/ EDKII
>website for additional instructions on setting up a development environment).
>|               |
> |            | Added new system environment variables,
>|               |
> |            | PACKAGES_PATH and EDK_TOOLS_BIN, used by the build system.
>|               |
> |            | Allow INF statements in FD regions.
>|               |
> |            | Clarified [UserExtensions] content in chapter 2 (to match
>implementation)                                                                                                  |               |
>-| 1.28       | Convert to GitBooks
>| June 2017     |
>+| 1.27       | Convert to GitBooks
>| June 2017     |
> |            | [#426](https://bugzilla.tianocore.org/show_bug.cgi?id=426)
>IMAGE_TYPE_ID must be provided with value, FDF should mark it as required
>section                               |               |
> |            | [#373](https://bugzilla.tianocore.org/show_bug.cgi?id=373)
>Conditional statement examples incorrect
>|               |
> |            | [#461](https://bugzilla.tianocore.org/show_bug.cgi?id=461) FDF
>Spec: add a super script number for the <FmpFileData>
>|               |
> |            | [#249](https://bugzilla.tianocore.org/show_bug.cgi?id=249) FDF
>spec miss '<UiFmpName>' definition                                                                          |
>|
> |            | [#350](https://bugzilla.tianocore.org/show_bug.cgi?id=350) [FDF
>Spec] Extend the macro usage in the !include statement
>|               |
>@@ -206,7 +206,8 @@ Copyright (c) 2006-2017, Intel Corporation. All rights
>reserved.
> |            | [#142](https://bugzilla.tianocore.org/show_bug.cgi?id=142) Update
>EDK II FDF Specification to allow sections in any order
>|               |
> |            | [#478](https://bugzilla.tianocore.org/show_bug.cgi?id=478) FDF
>spec: extend the <FmpFileData> to support <FvStatements> and
><FdStatenents>                                 |               |
> |            | [#353](https://bugzilla.tianocore.org/show_bug.cgi?id=353) Build
>spec: Allow nested includes in DSC and FDF files                                                          |
>|
> |            | [#520](https://bugzilla.tianocore.org/show_bug.cgi?id=520) FDF
>spec: Update Precedence of PCD Values                                                                       |
>|
> |            | [#585](https://bugzilla.tianocore.org/show_bug.cgi?id=585) FDF
>Spec: Update the FDF_SPECIFICATION version to 0x0001001B or 1.27
>|               |
>+| 1.28       | Update version to 1.28
>| March 2018    |
> |            | Per PI 1.6 to extend FFS alignment to 16M
>|               |
> |            | Per PI 1.6 to support FV extended header entry contain the used size
>of FV                                                                                                 |               |
>--
>2.6.1.windows.1