From ac6f0f88fac350bbdc5c4ad6ecf9fb7f93fbdf60 Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Mon, 15 Jun 2026 17:09:42 +0200 Subject: [PATCH] Actually describe the message severity levels. --- manual/tracy.md | 18 ++++++++++++++++-- manual/tracy.tex | 12 +++++++++++- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/manual/tracy.md b/manual/tracy.md index b6820411..72f49956 100644 --- a/manual/tracy.md +++ b/manual/tracy.md @@ -11,7 +11,7 @@ The user manual **Bartosz Taudul** [\](mailto:wolf@nereid.pl) -2026-06-14 +2026-06-15 # 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: diff --git a/manual/tracy.tex b/manual/tracy.tex index 0be16a9d..83f4eefe 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -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: