Browse Source

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@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>
Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>
Reviewed-by: Sai Chaganty <rangasai.v.chaganty@intel.com>
Michael Kubacki 4 years ago
parent
commit
9cc828d9d4

+ 8 - 0
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.

+ 8 - 0
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.

+ 8 - 0
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.

+ 8 - 0
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.

+ 8 - 0
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.

+ 8 - 0
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.

+ 8 - 0
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.
 

+ 8 - 0
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.