Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/wolfpld/tracy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorBartosz Taudul <wolf@nereid.pl>2022-08-16 01:17:59 +0300
committerBartosz Taudul <wolf@nereid.pl>2022-08-16 01:17:59 +0300
commit26e7d6eb3e96f29c3900b9c0cf8f13bf72b03ab0 (patch)
tree5627010c09ff87737cfe1e33d4a26c7b4f83c0ad /manual
parentcde56ef9fe05cde29e5b54be362cd9fbe86a5f57 (diff)
Update manual.
Diffstat (limited to 'manual')
-rw-r--r--manual/tracy.tex11
1 files changed, 7 insertions, 4 deletions
diff --git a/manual/tracy.tex b/manual/tracy.tex
index 611cead7..eb45ebc6 100644
--- a/manual/tracy.tex
+++ b/manual/tracy.tex
@@ -2970,12 +2970,15 @@ In this window, you can set various trace-related options. For example, the time
\item \emph{Source location dynamic} -- Zone color is determined by source location (function name) and depth level.
\end{itemize}
Enabling the \emph{Ignore custom} option will force usage of the selected zone coloring scheme, disregarding any colors set by the user in profiled code.
-\item \emph{\faBoxOpen{} Namespaces} -- controls display behavior of long zone names, which don't fit inside a zone box:
+\item \emph{\faRulerHorizontal{} Zone name shortening} -- controls display behavior of long zone names, which don't fit inside a zone box:
\begin{itemize}
-\item \emph{Full} -- Zone names are always fully displayed (e.g.\ \texttt{std::sort}).
-\item \emph{Shortened} -- Namespaces are shortened to one letter (e.g.\ \texttt{s::sort}).
-\item \emph{None} -- Namespaces are completely omitted (e.g.\ \texttt{sort}).
+\item \emph{Disabled} -- Shortening of zone names is not performed and names are always displayed in full (e.g.\ \texttt{bool ns::container<float>::add(const float\&)}).
+\item \emph{Minimal length} -- Always reduces zone name to minimal length, even if there is space available for a longer form (e.g.\ \texttt{add()}).
+\item \emph{Only normalize} -- Only performs normalization of the zone name\footnote{The normalization process removes the function \texttt{const} qualifier, some common return type declarations and all function parameters and template arguments.}, but does not remove namespaces (e.g.\ \texttt{ns::container<>::add()}).
+\item \emph{As needed} -- Name shortening steps will be performed only if there is no space to display a complete zone name, and only until the name fits available space, or shortening is no longer possible (e.g.\ \texttt{container<>::add()}).
+\item \emph{As needed + normalize} -- Same as above, but zone name normalization will always be performed, even if the entire zone name fits in the space available.
\end{itemize}
+Function names in the remaining places across the UI will be normalized unless this option is set to \emph{Disabled}.
\end{itemize}
\item \emph{\faLock{} Draw locks} -- Controls the display of locks. If the \emph{Only contended} option is selected, the profiler won't display the non-blocking regions of locks (see section~\ref{zoneslocksplots}). The \emph{Locks} drop-down allows disabling the display of locks on a per-lock basis. As a convenience, the list of locks is split into the single-threaded and multi-threaded (contended and uncontended) categories. Clicking the \RMB{}~right mouse button on a lock label opens the lock information window (section~\ref{lockwindow}).
\item \emph{\faSignature{} Draw plots} -- Allows disabling display of plots. Individual plots can be disabled in the \emph{Plots} drop-down.