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

FmpDevicePkg: Improve library documentation [Rebase & FF] #300

Open
wants to merge 1 commit into
base: release/202405
Choose a base branch
from

Conversation

os-d
Copy link
Contributor

@os-d os-d commented Jul 4, 2024

Description

Adds a ReadMe.md to each library instance and updates FmpDevicePkg_ReadMe.md to reference available library documentation.

Cherry-picked from: 61d7c67.

  • 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

From 2311.

Integration Instructions

N/A.

Adds a ReadMe.md to each library instance and updates
FmpDevicePkg_ReadMe.md to reference available library
documentation.
@os-d os-d requested review from makubacki and kuqin12 July 4, 2024 16:06
@github-actions github-actions bot added impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation labels Jul 4, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release/202405@14a359e). Learn more about missing BASE report.

Additional details and impacted files
@@                Coverage Diff                @@
##             release/202405     #300   +/-   ##
=================================================
  Coverage                  ?   86.59%           
=================================================
  Files                     ?       13           
  Lines                     ?     2126           
  Branches                  ?      306           
=================================================
  Hits                      ?     1841           
  Misses                    ?      269           
  Partials                  ?       16           
Flag Coverage Δ
FmpDevicePkg 63.79% <ø> (?)
SecurityPkg 91.05% <ø> (?)

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.

@makubacki makubacki changed the title FmpDevicePkg: Improve library documentation FmpDevicePkg: Improve library documentation [Rebase & FF] Jul 4, 2024
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.

None yet

5 participants