From 0e50c9f6eabae38e1c2d14d190b46cc06f059f55 Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Fri, 13 Nov 2020 13:13:11 +0100 Subject: [PATCH] Update manual. --- manual/tracy.tex | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/manual/tracy.tex b/manual/tracy.tex index fd4d8cce..34e863a4 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -393,7 +393,10 @@ noborder=true, couleur=black!5, logo=\bcbombe ]{Important} -Double-check that the define name is entered correctly (as \texttt{TRACY\_ENABLE}), don't make a mistake of adding an additional \texttt{D} at the end. Make sure that this macro is defined for all files across your project (e.g. it should be specified in the \texttt{CFLAGS} variable, which is always passed to the compiler, or in an equivalent way), and \emph{not} as a \texttt{\#define} in just some of the source files. +\begin{itemize} +\item Double-check that the define name is entered correctly (as \texttt{TRACY\_ENABLE}), don't make a mistake of adding an additional \texttt{D} at the end. Make sure that this macro is defined for all files across your project (e.g. it should be specified in the \texttt{CFLAGS} variable, which is always passed to the compiler, or in an equivalent way), and \emph{not} as a \texttt{\#define} in just some of the source files. +\item The value of the define is not taken into consideration by Tracy, only the fact if the macro is defined, or not (unless specified otherwise). Be careful not to make a mistake of assigning numeric values to Tracy defines, which could lead you to being puzzled why constructs such as \texttt{TRACY\_ENABLE=0} don't work as you expect them to do. +\end{itemize} \end{bclogo} The application you want to profile should be compiled with all the usual optimization options enabled (i.e.~make a release build). It makes no sense to profile debugging builds, as the unoptimized code and additional checks (asserts, etc.) completely change how the program behaves.