public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [edk2-platforms][PATCH V1 1/1] Features/Intel: Add a Performance Impact section to Readme.md files
@ 2020-01-28  7:01 Kubacki, Michael A
  2020-01-30  2:49 ` Chiu, Chasel
  2020-01-30  7:10 ` Chaganty, Rangasai V
  0 siblings, 2 replies; 3+ messages in thread
From: Kubacki, Michael A @ 2020-01-28  7:01 UTC (permalink / raw)
  To: devel
  Cc: Dandan Bi, Sai Chaganty, Chasel Chiu, Nate DeSimone, Eric Dong,
	Liming Gao

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@intel.com>
Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>
Cc: Chasel Chiu <chasel.chiu@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael Kubacki <michael.a.kubacki@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


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

end of thread, other threads:[~2020-01-30  7:10 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-01-28  7:01 [edk2-platforms][PATCH V1 1/1] Features/Intel: Add a Performance Impact section to Readme.md files Kubacki, Michael A
2020-01-30  2:49 ` Chiu, Chasel
2020-01-30  7:10 ` Chaganty, Rangasai V

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