From 7cab8bc19182dadf69bad73b2c8c436e5d1166b4 Mon Sep 17 00:00:00 2001 From: Michael Kubacki Date: Mon, 27 Jan 2020 22:53:49 -0800 Subject: [PATCH] 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 Cc: Sai Chaganty Cc: Chasel Chiu Cc: Nate DeSimone Cc: Eric Dong Cc: Liming Gao Signed-off-by: Michael Kubacki Reviewed-by: Chasel Chiu Reviewed-by: Sai Chaganty --- Debugging/AcpiDebugFeaturePkg/Readme.md | 8 ++++++++ Debugging/Usb3DebugFeaturePkg/Readme.md | 8 ++++++++ Network/NetworkFeaturePkg/Readme.md | 8 ++++++++ OutOfBandManagement/IpmiFeaturePkg/Readme.md | 8 ++++++++ PowerManagement/S3FeaturePkg/Readme.md | 8 ++++++++ SystemInformation/SmbiosFeaturePkg/Readme.md | 8 ++++++++ TemplateFeaturePkg/Readme.md | 8 ++++++++ UserInterface/UserAuthFeaturePkg/Readme.md | 8 ++++++++ 8 files changed, 64 insertions(+) diff --git a/Debugging/AcpiDebugFeaturePkg/Readme.md b/Debugging/AcpiDebugFeaturePkg/Readme.md index 19b4aab..af78598 100644 --- a/Debugging/AcpiDebugFeaturePkg/Readme.md +++ b/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/Debugging/Usb3DebugFeaturePkg/Readme.md b/Debugging/Usb3DebugFeaturePkg/Readme.md index 6bbe301..bbe0073 100644 --- a/Debugging/Usb3DebugFeaturePkg/Readme.md +++ b/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/Network/NetworkFeaturePkg/Readme.md b/Network/NetworkFeaturePkg/Readme.md index 4abedb1..677ecc2 100644 --- a/Network/NetworkFeaturePkg/Readme.md +++ b/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/OutOfBandManagement/IpmiFeaturePkg/Readme.md b/OutOfBandManagement/IpmiFeaturePkg/Readme.md index f091fbe..da3fc30 100644 --- a/OutOfBandManagement/IpmiFeaturePkg/Readme.md +++ b/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/PowerManagement/S3FeaturePkg/Readme.md b/PowerManagement/S3FeaturePkg/Readme.md index b1d835a..d6a2063 100644 --- a/PowerManagement/S3FeaturePkg/Readme.md +++ b/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/SystemInformation/SmbiosFeaturePkg/Readme.md b/SystemInformation/SmbiosFeaturePkg/Readme.md index 60d60cd..509ce96 100644 --- a/SystemInformation/SmbiosFeaturePkg/Readme.md +++ b/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/TemplateFeaturePkg/Readme.md b/TemplateFeaturePkg/Readme.md index f0bafba..5066277 100644 --- a/TemplateFeaturePkg/Readme.md +++ b/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/UserInterface/UserAuthFeaturePkg/Readme.md b/UserInterface/UserAuthFeaturePkg/Readme.md index d54ff75..8a7d394 100644 --- a/UserInterface/UserAuthFeaturePkg/Readme.md +++ b/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.