Added a graph to describe how logging level works

microsoft · Oct 11, 2023 · a4fc465 · a4fc465
1 parent 277d455
commit a4fc465
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/AdvLoggerPkg/Docs/ReadMe.md b/AdvLoggerPkg/Docs/ReadMe.md
@@ -247,6 +247,12 @@ and the follow change is needed in the .fdf:
 The v3 data header supports a new field of hardware debugging level to support setting the serial print configurable
 during boot time.
 
+All debug prints will be filtered by multiple build time flags, such as `PcdDebugPrintErrorLevel`, `MDEPKG_NDEBUG`, etc.
+These prints that passes such filters will be logged to memory, and then fed to the hardware port library to be checked
+against the hardware print level. A full data flow chart is shown below:
+
+![Debug Logging Level Filters](debug_log_level.png)
+
 The default value will be initialized to the value of `PcdAdvancedLoggerHdwPortDebugPrintErrorLevel` in the PEI core,
 DXE core, or MM core, whichever comes first during the boot process.
 

diff --git a/AdvLoggerPkg/Docs/debug_log_level.png b/AdvLoggerPkg/Docs/debug_log_level.png