From 5f60ac7ad204943dc2a527b9243a6618f51734e5 Mon Sep 17 00:00:00 2001 From: Tiago Rodrigues Date: Mon, 13 Nov 2023 13:42:30 -0500 Subject: [PATCH] update docs --- manual/techdoc.tex | 2 +- manual/tracy.tex | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/manual/techdoc.tex b/manual/techdoc.tex index 02189d4d..6492e81a 100644 --- a/manual/techdoc.tex +++ b/manual/techdoc.tex @@ -258,7 +258,7 @@ This is a very OS-specific task. It is split into two parts: getting the call st On some platforms a bit of setup work is required. This is done in the \texttt{InitCallstack()} function. -On windows, tracy will attempt to preload symbols at \texttt{InitCallstack()} time. It does this for device drivers and process modules. As this process can be slow when a lot of pdbs are involved, you can set the \texttt{TRACY\_NO\_DBHELP\_INIT\_LOAD} environment variable to "1" to disable this behavior and rely on-demand symbol loading. +On Windows, tracy will attempt to preload symbols at \texttt{InitCallstack()} time. It does this for device drivers and process modules. As this process can be slow when a lot of pdbs are involved, you can set the \texttt{TRACY\_NO\_DBHELP\_INIT\_LOAD} environment variable to "1" to disable this behavior and rely on-demand symbol loading. \subsubsection{Getting the frames} diff --git a/manual/tracy.tex b/manual/tracy.tex index 2563ec38..742a8368 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -1776,6 +1776,8 @@ void DbgHelpUnlock() { ReleaseMutex(dbgHelpLock); } } \end{lstlisting} +At initilization time, tracy will attempt to preload symbols for device drivers and process modules. As this process can be slow when a lot of pdbs are involved, you can set the \texttt{TRACY\_NO\_DBHELP\_INIT\_LOAD} environment variable to "1" to disable this behavior and rely on-demand symbol loading. + \paragraph{Disabling resolution of inline frames} Inline frames retrieval on Windows can be multiple orders of magnitude slower than just performing essential symbol resolution. This manifests as profiler seemingly being stuck for a long time, having hundreds of thousands of query backlog entries queued, which are slowly trickling down. If your use case requires speed of operation rather than having call stacks with inline frames included, you may define the \texttt{TRACY\_NO\_CALLSTACK\_INLINES} macro, which will make the profiler stick to the basic but fast frame resolution mode.