About Social Code
aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmma Anholt <emma@anholt.net>2025-10-10 15:59:15 -0700
committerMarge Bot <marge-bot@fdo.invalid>2025-11-05 19:19:02 +0000
commit09793f02bc5a73478a957ebefe8e11182907f83e (patch)
tree95ffcd00aa3257873d3fd1cd649748d7b8dc8174 /docs
parented40f0e22a2a13b0b42202097afc5f1e140c702a (diff)
docs/perfetto: Be more clear about the role of MESA_GPU_TRACES=perfetto
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/37826>
Diffstat (limited to 'docs')
-rw-r--r--docs/perfetto.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/docs/perfetto.rst b/docs/perfetto.rst
index b7778e6241f..69d2810757e 100644
--- a/docs/perfetto.rst
+++ b/docs/perfetto.rst
@@ -129,17 +129,20 @@ Currently, only EGL and the following drivers have CPU tracepoints.
- VC4
- V3DV
-Vulkan data sources
-~~~~~~~~~~~~~~~~~~~
-
-The Vulkan API gives the application control over recording of command
-buffers as well as when they are submitted to the hardware. As a
-consequence, we need to ensure command buffers are properly
-instrumented for the Perfetto driver data sources prior to Perfetto
-actually collecting traces.
-
-This can be achieved by setting the :envvar:`MESA_GPU_TRACES`
-environment variable before starting a Vulkan application :
+Render stage data sources
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The render stage data sources are the driver-specific traces of command buffer
+execution on the GPU.
+
+The Vulkan API gives the application control over recording of command buffers
+as well as when they are submitted to the hardware, and command buffers can be
+recorded once and reused repeatedly. Trace commands are normally only recorded
+into a command buffer when a perfetto trace is active. Most applications don't
+reuse command buffers, so you'll see traces appear shortly after the trace was
+started, but if you have one of the rare applications that reuses command
+buffers, you'll need to set the :envvar:`MESA_GPU_TRACES` environment variable
+before starting a Vulkan application :
.. code-block:: sh