microsoft / mu_feature_config

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

Added documentation for profile tooling #269

Closed kuqin12 closed 1 year ago

kuqin12 commented 1 year ago

Preface

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

Description

This change added a few sections describing the process of profile CSV creation and how to integrate them into the platform build process.

In addition, this change also adds the documentation for newly introduced profile name and ID. Specifically, the data flow in firmware and platform integration steps are described in the doc.

Resolves https://github.com/microsoft/mu_feature_config/issues/241

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

N/A. Documentation change only.

Integration Instructions

N/A

codecov-commenter commented 1 year ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (6db4dba) 27.39% compared to head (75bfa76) 27.39%.

:exclamation: Current head 75bfa76 differs from pull request most recent head 53566ed. Consider uploading reports for the commit 53566ed to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #269 +/- ## ======================================= Coverage 27.39% 27.39% ======================================= Files 16 16 Lines 4552 4552 ======================================= Hits 1247 1247 Misses 3305 3305 ``` | [Flag](https://app.codecov.io/gh/microsoft/mu_feature_config/pull/269/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/269/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=microsoft) | `27.39% <ø> (ø)` | | 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.