From 6d9215ac6545426833f313c83a5e3eba04f7f35b Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Wed, 8 Aug 2018 22:24:11 +0200 Subject: [PATCH] Add a markup quick start guide. --- manual/tracy.tex | 2 ++ 1 file changed, 2 insertions(+) diff --git a/manual/tracy.tex b/manual/tracy.tex index 948351f4..39ae447e 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -195,6 +195,8 @@ Be aware that even if you already have thread naming functionality implemented, With the aforementioned steps you will be able to connect to the profiled program, but there won't be any data collection performed. In order to begin profiling, Tracy requires that you manually instrument the application\footnote{Automatic tracing of every entered function is not feasible due to the amount of data that would generate.}. All the user-facing interface is contained in the \texttt{tracy/Tracy.hpp} header file. +The best way to start is to add markup to the main loop of the application, along with a few function that are called there. This will give you a rough outline of the function's time cost, which you may then further refine by instrumenting functions deeper in the call stack. + \subsection{Handling text strings} When dealing with Tracy macros, you will encounter two ways of providing string data to the profiler. In both cases you should pass \texttt{const char*} pointers, but there are differences in expected life-time of the pointed data.