microsoft / mu_feature_config

Project Mu - Feature Repo - UEFI User Config and Management Support
https://microsoft.github.io/mu/
Other
19 stars 24 forks source link

Required changes to KnobService and XML Schema to enable per-library header definitions and XML merging #357

Closed mario-posso-escobar closed 2 months ago

mario-posso-escobar commented 3 months ago

Preface

Please ensure you have read the contribution docs prior to submitting the pull request. In particular, pull request guidelines.

Description

Add a header reference field to the XML definitions to allow flexible build inclusion patterns.

For each item, place an "x" in between [ and ] if true. Example: [x]. (you can also check items in the GitHub UI)

How This Was Tested

Tested with locally updated sampleschema.xml. Tested end-to-end with SCP firmware.

Integration Instructions

'headerRef' is an optional attribute that, when used, is consumed by KnobService to reference headers instead of generating the 'Enum' and 'Struct' type definitions in-place. This attribute will not breaking existing XMLs.

mario-posso-escobar commented 3 months ago

@microsoft-github-policy-service agree company="Microsoft"

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 1.37931% with 143 lines in your changes missing coverage. Please review.

Project coverage is 35.92%. Comparing base (e21d89d) to head (2ace030).

:exclamation: Current head 2ace030 differs from pull request most recent head 6278031

Please upload reports for the commit 6278031 to get more accurate results.

Files Patch % Lines
SetupDataPkg/Tools/KnobService.py 0.00% 143 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #357 +/- ## ========================================== - Coverage 36.18% 35.92% -0.27% ========================================== Files 31 31 Lines 6268 6319 +51 Branches 669 669 ========================================== + Hits 2268 2270 +2 - Misses 3994 4043 +49 Partials 6 6 ``` | [Flag](https://app.codecov.io/gh/microsoft/mu_feature_config/pull/357/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=microsoft) | Coverage Δ | | |---|---|---| | [Linux](https://app.codecov.io/gh/microsoft/mu_feature_config/pull/357/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=microsoft) | `27.24% <1.37%> (-0.26%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=microsoft#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

apop5 commented 2 months ago

I guess we need the documentation updated as well to show an example of how to utilize this new functionality.