Skip to content

Commit 7158153

Browse files
committed
Rebuild markdown manual.
1 parent 4f64b97 commit 7158153

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

manual/tracy.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The user manual
1212

1313
**Bartosz Taudul** [\<wolf@nereid.pl\>](mailto:wolf@nereid.pl)
1414

15-
2026-05-30 <https://github.com/wolfpld/tracy>
15+
2026-06-05 <https://github.com/wolfpld/tracy>
1616
:::
1717

1818
# Quick overview {#quick-overview .unnumbered}
@@ -1585,7 +1585,7 @@ Similar to Vulkan and OpenGL, you also need to periodically collect the OpenCL e
15851585

15861586
### CUDA
15871587

1588-
CUDA support is enabled by including the `public/tracy/TracyCUDA.hpp` header file. To use it, the NVIDIA CUPTI library is required. This library comes with the NVIDIA CUDA Toolkit and is located at `CUDA_INSTALLATION_PATH/extras/CUPTI`.
1588+
CUDA support is enabled by including the `public/tracy/TracyCUDA.hpp` header file. To use it, make sure you have the NVIDIA CUDA Toolkit v12.4 (or later) installed, and that the NVIDIA CUPTI library is available in the toolkit (located at `CUDA_INSTALLATION_PATH/extras/CUPTI`).
15891589

15901590
Tracing CUDA requires the creation of a Tracy CUDA context using the macro `TracyCUDAContext()`, which returns an instance of a `tracy::CUDACtx` object. TracyCUDA allows only a single `tracy::CUDACtx` object at any given time. Subsequent calls to `TracyCUDAContext()` will return the same reference-counted object. There is no need for clients to instantiate multiple `tracy::CUDACtx` objects, as a single context is capable of instrumenting all CUDA contexts and streams.
15911591

@@ -3623,7 +3623,7 @@ Annotations are displayed on the timeline, as presented in figure [21](#annotat
36233623
<figcaption>Annotation region.</figcaption>
36243624
</figure>
36253625

3626-
Please note that while the annotations persist between profiling sessions, they are not saved in the trace but in the user data files, as described in section [9.2](#tracespecific).
3626+
Please note that while the annotations persist between profiling sessions, they are not saved in the trace but in the trace sidecar file, as described in section [9.2](#tracespecific).
36273627

36283628

36293629
-----
@@ -4159,6 +4159,8 @@ The information about the selected memory allocation is displayed in this window
41594159

41604160
This window contains information about the current trace: captured program name, time of the capture, profiler version which performed the capture, and a custom trace description, which you can fill in.
41614161

4162+
If the * Public sidecar* option is selected, the file containing trace-specific user settings (see section [9.2](#tracespecific)) will be saved on disk next to the trace file.
4163+
41624164
Open the *Trace statistics* section to see information about the trace, such as achieved timer resolution, number of captured zones, lock events, plot data points, memory allocations, etc.
41634165

41644166
There's also a section containing the selected frame set timing statistics and histogram[^90]. As a convenience, you can switch the active frame set here and limit the displayed frame statistics to the frame range visible on the screen.
@@ -4180,12 +4182,17 @@ The *Source location substitutions* section allows adapting the source file path
41804182
>
41814183
> - `\\` `/`
41824184

4183-
By default, all source file modification times need to be older than the cature time of the trace. This can be disabled using the *Enforce source file modification time older than trace capture time* check box, i.e. when the source files are under source control and the file modification time is not relevant.
4185+
By default, all source file modification times need to be older than the capture time of the trace. This can be disabled using the *Enforce source file modification time older than trace capture time* check box, i.e. when the source files are under source control and the file modification time is not relevant.
41844186

41854187
In this window, you can view the information about the machine on which the profiled application was running. This includes the operating system, used compiler, CPU name, total available RAM, etc. In addition, if application information was provided (see section [3.7.1](#appinfo)), it will also be displayed here.
41864188

41874189
If an application should crash during profiling (section [2.5](#crashhandling)), the profiler will display the crash information in this window. It provides you information about the thread that has crashed, the crash reason, and the crash call stack (section [5.15](#callstackwindow)).
41884190

4191+
4192+
-----
4193+
4194+
 - User Gear icon
4195+
41894196
## Zone information window {#zoneinfo}
41904197

41914198
The zone information window displays detailed information about a single zone. There can be only one zone information window open at any time. While the window is open, the profiler will highlight the zone on the timeline view with a green outline. The following data is presented:
@@ -4966,9 +4973,9 @@ Various files at the root configuration directory store common profiler state su
49664973

49674974
Trace files saved on disk are immutable and can't be changed. Still, it may be desirable to store additional per-trace information to be used by the profiler, for example, a custom description of the trace or the timeline view position used in the previous profiling session.
49684975

4969-
This external data is stored in the `user/[letter]/[program]/[week]/[epoch]` directory, relative to the configuration's root directory. The `program` part is the name of the profiled application (for example `program.exe`). The `letter` part is the first letter of the profiled application's name. The `week` part is a count of weeks since the Unix epoch, and the `epoch` part is a count of seconds since the Unix epoch. This rather unusual convention prevents the creation of directories with hundreds of entries.
4976+
This external sidecar data is stored by default in the `sidecar/[program]/[date].json` file, relative to the configuration root directory. The `program` part is the name of the profiled application (for example `program.exe`). The `date` part is in year-month-day-*dash*-hour-minutes-seconds format.
49704977

4971-
The profiler never prunes user settings.
4978+
The sidecar file can be made public (see section [5.13](#traceinfo)), in which case it will be placed next to the trace file with the `.json` extension, allowing both files to be easily moved or copied.
49724979

49734980
## Cache files
49744981

0 commit comments

Comments
 (0)