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: fix AdvLoggerSerialPortLib class #268

Merged
merged 2 commits into from
Jun 26, 2023

Conversation

Javagedes
Copy link
Contributor

Description

AdvLoggerSerialPortLib was using a library class that was not a true library class (not defined in any .dec file or have an associated .h).

This changes the library class to use the correct library class, SerialPortLib.

  • 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

Successfully build multiple platforms and pass the newly added BaseTools change for verifying library override class names.

Integration Instructions

Any library class definitions in a dsc using AdvLoggerSerialPortLib needs to be switched to SerialPortLib.

AdvLoggerSerialPortLib was using a library class that was not a true
library class (not defined in any .dec file or have an associated .h).

This changes the library class to use the correct library class,
SerialPortLib.
@Javagedes Javagedes requested review from makubacki and kuqin12 June 23, 2023 21:58
@github-actions github-actions bot added impact:breaking-change Requires integration attention impact:non-functional Does not have a functional impact labels Jun 23, 2023
Copy link
Member

@makubacki makubacki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving assuming there's not an unobvious reason the library class name was set this way.

The library appears to currently be missing in https://github.com/microsoft/mu_plus/blob/release/202302/AdvLoggerPkg/Docs/ReadMe.md

@kuqin12
Copy link
Contributor

kuqin12 commented Jun 24, 2023

I think this one is good. I noticed that the original breakage for my use case was actually a misusage after all. But I think this change is still needed for other cases in SerialStatusCodeHandlerPei

@Javagedes Javagedes merged commit 819d93c into release/202302 Jun 26, 2023
@Javagedes Javagedes deleted the fix-advloggerserialportlib-libraryclass branch June 26, 2023 18:04
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jun 29, 2023
Introduces 1 new commits in [Common/MU](https://github.com/microsoft/mu_plus.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_plus/commit/819d93ca1dec56cfe446f5c0057e7ffe56f51249">819d93</a> AdvLoggerPkg: fix AdvLoggerSerialPortLib class (<a href="https://github.com/microsoft/mu_plus/pull/268">#268</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
makubacki referenced this pull request in microsoft/mu_tiano_platforms Jun 29, 2023
Bumps Common/MU from `2023020000.1.0` to `2023020001.0.0`

Introduces 1 new commits in
[Common/MU](https://github.com/microsoft/mu_plus.git).

<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/microsoft/mu_plus/commit/819d93ca1dec56cfe446f5c0057e7ffe56f51249">819d93</a>
AdvLoggerPkg: fix AdvLoggerSerialPortLib class (<a
href="https://github.com/microsoft/mu_plus/pull/268">#268</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:breaking-change Requires integration attention impact:non-functional Does not have a functional impact
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants