Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for profile tooling #269

Merged
merged 8 commits into from
Nov 15, 2023
Merged

Conversation

kuqin12
Copy link
Contributor

@kuqin12 kuqin12 commented Oct 29, 2023

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 #241

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

  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

N/A. Documentation change only.

Integration Instructions

N/A

@github-actions github-actions bot added impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation labels Oct 29, 2023
@kuqin12 kuqin12 requested a review from apop5 October 29, 2023 15:48
@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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

❗ 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
@@           Coverage Diff           @@
##             main     #269   +/-   ##
=======================================
  Coverage   27.39%   27.39%           
=======================================
  Files          16       16           
  Lines        4552     4552           
=======================================
  Hits         1247     1247           
  Misses       3305     3305           
Flag Coverage Δ
Linux 27.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

kuqin12 and others added 3 commits October 31, 2023 11:02
Co-authored-by: Aaron <105021049+apop5@users.noreply.github.com>
Co-authored-by: Aaron <105021049+apop5@users.noreply.github.com>
@kuqin12 kuqin12 enabled auto-merge (squash) October 31, 2023 18:08
@kuqin12 kuqin12 merged commit 6666855 into microsoft:main Nov 15, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Using ConfigEditor to generate individual profiles
4 participants