public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [edk2-FdfSpecification PATCH] Allow sections in any order
@ 2017-04-12 17:42 Michael Kinney
  2017-04-12 17:42 ` Michael Kinney
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Kinney @ 2017-04-12 17:42 UTC (permalink / raw)
  To: edk2-devel; +Cc: Liming Gao, Yonghong Zhu, Kevin W Shaw

https://bugzilla.tianocore.org/show_bug.cgi?id=142

GitHub branch for review:

  https://github.com/mdkinney/edk2-FdfSpecification/tree/Bugzilla_142_FdfSectionsAnyOrder
  
GitHub branch compare against latest DRAFT for review:

  https://github.com/tianocore-docs/edk2-FdfSpecification/compare/master...mdkinney:Bugzilla_142_FdfSectionsAnyOrder?w=1
  
Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>

Michael Kinney (1):
  Allow sections in any order

 3_edk_ii_fdf_file_format/32_fdf_definition.md | 24 ++++++++++++------------
 README.md                                     |  1 +
 2 files changed, 13 insertions(+), 12 deletions(-)

-- 
2.6.3.windows.1



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

* [edk2-FdfSpecification PATCH] Allow sections in any order
  2017-04-12 17:42 [edk2-FdfSpecification PATCH] Allow sections in any order Michael Kinney
@ 2017-04-12 17:42 ` Michael Kinney
  2017-04-13  1:30   ` Zhu, Yonghong
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Kinney @ 2017-04-12 17:42 UTC (permalink / raw)
  To: edk2-devel; +Cc: Liming Gao, Yonghong Zhu, Kevin W Shaw

https://bugzilla.tianocore.org/show_bug.cgi?id=142

Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 3_edk_ii_fdf_file_format/32_fdf_definition.md | 24 ++++++++++++------------
 README.md                                     |  1 +
 2 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/3_edk_ii_fdf_file_format/32_fdf_definition.md b/3_edk_ii_fdf_file_format/32_fdf_definition.md
index e4e9869..b8dffa8 100644
--- a/3_edk_ii_fdf_file_format/32_fdf_definition.md
+++ b/3_edk_ii_fdf_file_format/32_fdf_definition.md
@@ -33,7 +33,10 @@
 
 The FDF definitions define the final properties for a flash image - PCD
 settings in this file override any other PCD settings that may have been set in
-the platform description (DSC) file.
+the platform description (DSC) file. The `[Defines]` section, when specified,
+must appear before any other section except the header. (The header, when
+specified, is always the first section of an FDF file.) The remaining sections
+may be specified in any order within the FDF file.
 
 #### Summary
 
@@ -43,14 +46,14 @@ EBNF).
 ```c
 <EDK_II_FDF> ::= [<Header>]
                  [<Defines>]
-                 <FD>
-                 <FV>
-                 <Capsule>
-                 <FmpPayload>
-                 <VTF>
-                 <Rules>
-                 <OptionRom>
-                 <UserExtensions>
+                 <FD>*
+                 <FV>*
+                 <Capsule>*
+                 <FmpPayload>*
+                 <VTF>*
+                 <Rules>*
+                 <OptionRom>*
+                 <UserExtensions>*
 ```
 
 **********
@@ -62,9 +65,6 @@ override any variable/value assignment defined in the FDF file.
 **Note:** Conditional statements may be used anywhere within the FDF file, with
 the ability to group any item within a section as well as entire sections.
 **********
-**Note:** The sections must be listed in the above order within the FDF file.
-Changing the order may cause the build to break.
-**********
 
 ### 3.2.1 Common Definitions
 
diff --git a/README.md b/README.md
index f0ea3e4..45da9b5 100644
--- a/README.md
+++ b/README.md
@@ -203,3 +203,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
 |            | Changed the FDF_SPECIFICATION value from 0x0001001A to 0x0001001B or 1.27                                                                                                  |               |
 |            | Extended the FV and Capsule, FILE RAW statement formats to support multiple binary files.                                                                                  |               |
 |            | Changed section 3.8 [FmpPayload] to add definitions for MONOTONIC_COUNT and CERTIFICATE_GUID, plus some notes about how these are used.                                    |               |
+|            | [#142](https://bugzilla.tianocore.org/show_bug.cgi?id=142) Update EDK II FDF Specification to allow sections in any order                                                  |               |
-- 
2.6.3.windows.1



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

* Re: [edk2-FdfSpecification PATCH] Allow sections in any order
  2017-04-12 17:42 ` Michael Kinney
@ 2017-04-13  1:30   ` Zhu, Yonghong
  0 siblings, 0 replies; 3+ messages in thread
From: Zhu, Yonghong @ 2017-04-13  1:30 UTC (permalink / raw)
  To: Kinney, Michael D, edk2-devel@lists.01.org
  Cc: Gao, Liming, Shaw, Kevin W, Zhu, Yonghong

Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com> 

Best Regards,
Zhu Yonghong


-----Original Message-----
From: Kinney, Michael D 
Sent: Thursday, April 13, 2017 1:42 AM
To: edk2-devel@lists.01.org
Cc: Gao, Liming <liming.gao@intel.com>; Zhu, Yonghong <yonghong.zhu@intel.com>; Shaw, Kevin W <kevin.w.shaw@intel.com>
Subject: [edk2-FdfSpecification PATCH] Allow sections in any order

https://bugzilla.tianocore.org/show_bug.cgi?id=142

Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 3_edk_ii_fdf_file_format/32_fdf_definition.md | 24 ++++++++++++------------
 README.md                                     |  1 +
 2 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/3_edk_ii_fdf_file_format/32_fdf_definition.md b/3_edk_ii_fdf_file_format/32_fdf_definition.md
index e4e9869..b8dffa8 100644
--- a/3_edk_ii_fdf_file_format/32_fdf_definition.md
+++ b/3_edk_ii_fdf_file_format/32_fdf_definition.md
@@ -33,7 +33,10 @@
 
 The FDF definitions define the final properties for a flash image - PCD  settings in this file override any other PCD settings that may have been set in -the platform description (DSC) file.
+the platform description (DSC) file. The `[Defines]` section, when 
+specified, must appear before any other section except the header. (The 
+header, when specified, is always the first section of an FDF file.) 
+The remaining sections may be specified in any order within the FDF file.
 
 #### Summary
 
@@ -43,14 +46,14 @@ EBNF).
 ```c
 <EDK_II_FDF> ::= [<Header>]
                  [<Defines>]
-                 <FD>
-                 <FV>
-                 <Capsule>
-                 <FmpPayload>
-                 <VTF>
-                 <Rules>
-                 <OptionRom>
-                 <UserExtensions>
+                 <FD>*
+                 <FV>*
+                 <Capsule>*
+                 <FmpPayload>*
+                 <VTF>*
+                 <Rules>*
+                 <OptionRom>*
+                 <UserExtensions>*
 ```
 
 **********
@@ -62,9 +65,6 @@ override any variable/value assignment defined in the FDF file.
 **Note:** Conditional statements may be used anywhere within the FDF file, with  the ability to group any item within a section as well as entire sections.
 **********
-**Note:** The sections must be listed in the above order within the FDF file.
-Changing the order may cause the build to break.
-**********
 
 ### 3.2.1 Common Definitions
 
diff --git a/README.md b/README.md
index f0ea3e4..45da9b5 100644
--- a/README.md
+++ b/README.md
@@ -203,3 +203,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
 |            | Changed the FDF_SPECIFICATION value from 0x0001001A to 0x0001001B or 1.27                                                                                                  |               |
 |            | Extended the FV and Capsule, FILE RAW statement formats to support multiple binary files.                                                                                  |               |
 |            | Changed section 3.8 [FmpPayload] to add definitions for MONOTONIC_COUNT and CERTIFICATE_GUID, plus some notes about how these are used.                                    |               |
+|            | [#142](https://bugzilla.tianocore.org/show_bug.cgi?id=142) Update EDK II FDF Specification to allow sections in any order                                                  |               |
--
2.6.3.windows.1



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

end of thread, other threads:[~2017-04-13  1:30 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-04-12 17:42 [edk2-FdfSpecification PATCH] Allow sections in any order Michael Kinney
2017-04-12 17:42 ` Michael Kinney
2017-04-13  1:30   ` Zhu, Yonghong

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox