Scarfski/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy.git synced 2026-10-12 20:05:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Actually describe the message severity levels.

Browse Source
This commit is contained in:
Bartosz Taudul
2026-06-15 17:09:42 +02:00
parent 33fccb3530
commit ac6f0f88fa
2 changed files with 27 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
manual/tracy.md
View File

@@ -11,7 +11,7 @@ The user manual
**Bartosz Taudul** [\<wolf@nereid.pl\>](mailto:wolf@nereid.pl)
2026-06-14 <https://github.com/wolfpld/tracy>
2026-06-15 <https://github.com/wolfpld/tracy>
# Quick overview {#quick-overview .unnumbered}
@@ -1373,7 +1373,21 @@ Fast navigation in large data sets and correlating zones with what was happening
If you want to include color coding of the messages (for example to make critical messages easily visible), you can use `TracyMessageC(text, size, color)` or `TracyMessageLC(text, color)` macros.
Messages can also have different severity levels: `Trace`, `Debug`, `Info`, `Warning`, `Error` or `Fatal`. The `TracyMessage` macros will log messages with the severity `Info`. To log a message with a different severity, you may use the `TracyLogString` macro that regroups all the functionalities from the previous macros. We recommend writing your own macros, wrapping the different severities for easier use. You may provide a color of 0 if you do not want to set a color for this message.
Messages can also have different severity levels:
- *Trace* -- Broadly track variable states and events in the software program.
- *Debug* -- Describes variable states and details about specific internal events in the software, that are useful for investigations.
- *Info* -- Describes normal events, which inform on the expected progress and state of your software.
- *Warning* -- Describes potentially dangerous situations caused by unexpected events and states.
- *Error* -- Describes the occurrence of unexpected behavior. Does not interrupt the execution of the software.
- *Fatal* -- Describes a critical event that will lead to a software failure/crash.
The `TracyMessage` macros will log messages with the severity `Info`. To log a message with a different severity, you may use the `TracyLogString` macro that regroups all the functionalities from the previous macros. We recommend writing your own macros, wrapping the different severities for easier use. You may provide a color of 0 if you do not want to set a color for this message.
Examples:

12
manual/tracy.tex
View File

@@ -1560,7 +1560,17 @@ Fast navigation in large data sets and correlating zones with what was happening
If you want to include color coding of the messages (for example to make critical messages easily visible), you can use \texttt{TracyMessageC(text, size, color)} or \texttt{TracyMessageLC(text, color)} macros.
Messages can also have different severity levels: \texttt{Trace}, \texttt{Debug}, \texttt{Info}, \texttt{Warning}, \texttt{Error} or \texttt{Fatal}.
Messages can also have different severity levels:
\begin{itemize}
\item \emph{Trace} -- Broadly track variable states and events in the software program.
\item \emph{Debug} -- Describes variable states and details about specific internal events in the software, that are useful for investigations.
\item \emph{Info} -- Describes normal events, which inform on the expected progress and state of your software.
\item \emph{Warning} -- Describes potentially dangerous situations caused by unexpected events and states.
\item \emph{Error} -- Describes the occurrence of unexpected behavior. Does not interrupt the execution of the software.
\item \emph{Fatal} -- Describes a critical event that will lead to a software failure/crash.
\end{itemize}
The \texttt{TracyMessage} macros will log messages with the severity \texttt{Info}. To log a message with a different severity, you may use the \texttt{TracyLogString} macro that regroups all the functionalities from the previous macros. We recommend writing your own macros, wrapping the different severities for easier use. You may provide a color of 0 if you do not want to set a color for this message.
Examples: