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

AdvLoggerPkg: Remove NVMe Check from File Logger File Creation #517

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

os-d
Copy link
Contributor

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

Description

Currently, File Logger will only create the UefiLogs directory on the ESP if the device is an NVMe device. This is an unneccesary restriction and is removed in this patch.

  • 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

Tested on a system with a non-NVMe drive that failed to have the FileLogger directory created before this change and succeeds now.

Integration Instructions

If the integrating platform has a filesystem that does not support being logged to, it should set PcdAdvancedFileLoggerForceEnable to FALSE so that the directory is not attempted to be created.

Currently, File Logger will only create the UefiLogs directory on
the ESP if the device is an NVMe device. This is an unneccesary
restriction and is removed in this patch.
@os-d os-d requested review from kuqin12 and apop5 July 10, 2024 22:59
@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.04%. Comparing base (005cfdd) to head (633d0eb).

Additional details and impacted files
@@               Coverage Diff               @@
##           release/202311     #517   +/-   ##
===============================================
  Coverage           11.03%   11.04%           
===============================================
  Files                 144      144           
  Lines               22037    22019   -18     
  Branches             2356     2356           
===============================================
  Hits                 2432     2432           
+ Misses              19573    19555   -18     
  Partials               32       32           
Flag Coverage Δ
AdvLoggerPkg 3.65% <ø> (+0.01%) ⬆️

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.

@os-d os-d merged commit c024ed1 into microsoft:release/202311 Jul 11, 2024
30 checks passed
@os-d os-d deleted the advlogger_realloc branch July 11, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants