Skip to content

Commit

Permalink
[CHERRY-PICK] Removed reference to PcdAdvancedHdwLoggerDisable in the…
Browse files Browse the repository at this point in the history
… README (microsoft#541)

Removed reference to PcdAdvHdwLoggerDisable in the ReadMe MarkDown
document.

In commit 3833901,
PcdAdvancedSerialLoggerDisable in AdvLoggerPkg.dec was changed to
PcdAdvancedLoggerHdwPortDisable but in the ReadMe was changed to
PcdAdvancedHdwLoggerDisable.

This PCD was later removed from the .DEC in commit
8770182 but wasn't removed from the
ReadMe due to the naming difference.

- [ ] 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, ...
- [x] 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, ...

Ran CI for X64 Architecture. All Test Passed.

N/A
  • Loading branch information
Raymond-MS committed Aug 28, 2024
1 parent 4a68824 commit daa7650
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion AdvLoggerPkg/Docs/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ PCD's used by Advanced Logger
|PcdAdvancedLoggerForceEnable | The default operation is to check if a Logs directory is present in the root of the filesystem. If the UefiLogs directory is present, logging is enabled. When PcdAdvancedLoggerForceEnable is TRUE, and the device is not a USB device, a UefiLogs directory will be created and logging is enabled. When logging is enabled, the proper log files will be created if not already preset.|
|PcdAdvancedLoggerFixedInRAM | For systems that have a fixed memory buffer prior to UEFI. The full in memory log buffer is assumed.|
|PcdAdvancedHdwLoggerDebugPrintErrorLevel | The standard debug flags filter which log messages are produced. This PCD allow a subset of log messages to be forwarded to the Hdw Port Lib.|
|PcdAdvancedHdwLoggerDisable | Specifies when to disable writing to the Hdw Port.|
|PcdAdvancedLoggerPreMemPages | Amount of temporary RAM used for the debug log.|
|PcdAdvancedLoggerPages | Amount of system RAM used for the debug log|
|PcdAdvancedLoggerLocator | When enabled, the AdvLogger creates a variable "AdvLoggerLocator" with the address of the LoggerInfo buffer|
Expand Down

0 comments on commit daa7650

Please sign in to comment.