[edk2-devel] [edk2-platforms][PATCH V1 1/1] Features/Intel: Add a Performance Impact section to Readme.md files

Chaganty, Rangasai V rangasai.v.chaganty at intel.com
Thu Jan 30 07:10:27 UTC 2020 

Reviewed-by: Sai Chaganty <rangasai.v.chaganty at intel.com>

-----Original Message-----
From: Kubacki, Michael A <michael.a.kubacki at intel.com> 
Sent: Monday, January 27, 2020 11:01 PM
To: devel at edk2.groups.io
Cc: Bi, Dandan <dandan.bi at intel.com>; Chaganty, Rangasai V <rangasai.v.chaganty at intel.com>; Chiu, Chasel <chasel.chiu at intel.com>; Desimone, Nathaniel L <nathaniel.l.desimone at intel.com>; Dong, Eric <eric.dong at intel.com>; Gao, Liming <liming.gao at intel.com>
Subject: [edk2-platforms][PATCH V1 1/1] Features/Intel: Add a Performance Impact section to Readme.md files

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

Performance impact is an important consideration for feature integration. This new section captures the general expectation for overall boot performance impact due to using an advanced feature.

Cc: Dandan Bi <dandan.bi at intel.com>
Cc: Sai Chaganty <rangasai.v.chaganty at intel.com>
Cc: Chasel Chiu <chasel.chiu at intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone at intel.com>
Cc: Eric Dong <eric.dong at intel.com>
Cc: Liming Gao <liming.gao at intel.com>
Signed-off-by: Michael Kubacki <michael.a.kubacki at intel.com>
---
 Features/Intel/Debugging/AcpiDebugFeaturePkg/Readme.md      | 8 ++++++++
 Features/Intel/Debugging/Usb3DebugFeaturePkg/Readme.md      | 8 ++++++++
 Features/Intel/Network/NetworkFeaturePkg/Readme.md          | 8 ++++++++
 Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md | 8 ++++++++
 Features/Intel/PowerManagement/S3FeaturePkg/Readme.md       | 8 ++++++++
 Features/Intel/SystemInformation/SmbiosFeaturePkg/Readme.md | 8 ++++++++
 Features/Intel/TemplateFeaturePkg/Readme.md                 | 8 ++++++++
 Features/Intel/UserInterface/UserAuthFeaturePkg/Readme.md   | 8 ++++++++
 8 files changed, 64 insertions(+)

diff --git a/Features/Intel/Debugging/AcpiDebugFeaturePkg/Readme.md b/Features/Intel/Debugging/AcpiDebugFeaturePkg/Readme.md
index bbd7675c11..9868d6d816 100644
--- a/Features/Intel/Debugging/AcpiDebugFeaturePkg/Readme.md
+++ b/Features/Intel/Debugging/AcpiDebugFeaturePkg/Readme.md
@@ -115,6 +115,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/Debugging/Usb3DebugFeaturePkg/Readme.md b/Features/Intel/Debugging/Usb3DebugFeaturePkg/Readme.md
index a6b7cfc363..dc92f108ff 100644
--- a/Features/Intel/Debugging/Usb3DebugFeaturePkg/Readme.md
+++ b/Features/Intel/Debugging/Usb3DebugFeaturePkg/Readme.md
@@ -93,6 +93,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/Network/NetworkFeaturePkg/Readme.md b/Features/Intel/Network/NetworkFeaturePkg/Readme.md
index 6c670b005c..af59fc427a 100644
--- a/Features/Intel/Network/NetworkFeaturePkg/Readme.md
+++ b/Features/Intel/Network/NetworkFeaturePkg/Readme.md
@@ -93,6 +93,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md
index e70f1e850b..1af5b0cfda 100644
--- a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md
+++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md
@@ -82,6 +82,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/PowerManagement/S3FeaturePkg/Readme.md b/Features/Intel/PowerManagement/S3FeaturePkg/Readme.md
index f9b60b3f0c..95ce2ddc15 100644
--- a/Features/Intel/PowerManagement/S3FeaturePkg/Readme.md
+++ b/Features/Intel/PowerManagement/S3FeaturePkg/Readme.md
@@ -87,6 +87,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/SystemInformation/SmbiosFeaturePkg/Readme.md b/Features/Intel/SystemInformation/SmbiosFeaturePkg/Readme.md
index 7f31094365..6ecca8af4b 100644
--- a/Features/Intel/SystemInformation/SmbiosFeaturePkg/Readme.md
+++ b/Features/Intel/SystemInformation/SmbiosFeaturePkg/Readme.md
@@ -89,6 +89,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
diff --git a/Features/Intel/TemplateFeaturePkg/Readme.md b/Features/Intel/TemplateFeaturePkg/Readme.md
index 90be279ae3..fc77340684 100644
--- a/Features/Intel/TemplateFeaturePkg/Readme.md
+++ b/Features/Intel/TemplateFeaturePkg/Readme.md
@@ -65,6 +65,14 @@ functional on their board.
 ## Feature Enabling Checklist
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 Common size or performance tuning options for this feature.
 
diff --git a/Features/Intel/UserInterface/UserAuthFeaturePkg/Readme.md b/Features/Intel/UserInterface/UserAuthFeaturePkg/Readme.md
index 46049ea02e..b236d2ad30 100644
--- a/Features/Intel/UserInterface/UserAuthFeaturePkg/Readme.md
+++ b/Features/Intel/UserInterface/UserAuthFeaturePkg/Readme.md
@@ -83,6 +83,14 @@ functional on their board.
 *_TODO_*
 An ordered list of required activities to achieve desired functionality for the feature.
 
+## Performance Impact
+A general expectation for the impact on overall boot performance due to using this feature.
+
+This section is expected to provide guidance on:
+* How to estimate performance impact due to the feature
+* How to measure performance impact of the feature
+* How to manage performance impact of the feature
+
 ## Common Optimizations
 *_TODO_*
 Common size or performance tuning options for this feature.
--
2.16.2.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#53564): https://edk2.groups.io/g/devel/message/53564
Mute This Topic: https://groups.io/mt/70213199/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-

More information about the edk2-devel-archive mailing list