diff --git a/docs/drivers/d3d12.rst b/docs/drivers/d3d12.rst index b752b6f5120..7d2adca95f7 100644 --- a/docs/drivers/d3d12.rst +++ b/docs/drivers/d3d12.rst @@ -17,33 +17,33 @@ environment variables: .. envvar:: D3D12_DEBUG ("") -``verbose`` - Enable verbose output to stdout -``blit`` - Trace blit and copy resource calls -``experimental`` - Enable experimental shader models feature -``dxil`` - Dump DXIL during program compile -``disass`` - Dump disassambly of created DXIL shader -``res`` - Debug resources -``debuglayer`` - Enable `debug layer`_ -``gpuvalidator`` - Enable `GPU validator`_ + ``verbose`` + Enable verbose output to stdout + ``blit`` + Trace blit and copy resource calls + ``experimental`` + Enable experimental shader models feature + ``dxil`` + Dump DXIL during program compile + ``disass`` + Dump disassambly of created DXIL shader + ``res`` + Debug resources + ``debuglayer`` + Enable `debug layer`_ + ``gpuvalidator`` + Enable `GPU validator`_ .. envvar:: DXIL_DEBUG ("") -``verbose`` - Enable verbose output to stdout -``dump_blob`` - Write shader blobs -``trace`` - Trace instruction conversion -``dump_module`` - dump module tree to stderr + ``verbose`` + Enable verbose output to stdout + ``dump_blob`` + Write shader blobs + ``trace`` + Trace instruction conversion + ``dump_module`` + dump module tree to stderr .. _debug layer: https://learn.microsoft.com/en-us/windows/win32/direct3d12/understanding-the-d3d12-debug-layer .. _GPU validator: https://learn.microsoft.com/en-us/windows/win32/direct3d12/using-d3d12-debug-layer-gpu-based-validation @@ -55,7 +55,7 @@ Environment variables that control the behavior of the D3D12 driver. .. envvar:: MESA_D3D12_DEFAULT_ADAPTER_NAME ("") -Specifies a substring to search for when choosing a default adapter to -run on. The first adapter matching the substring is chosen. The substring -is not case sensitive. + Specifies a substring to search for when choosing a default adapter to + run on. The first adapter matching the substring is chosen. The substring + is not case sensitive. diff --git a/docs/drivers/lima.rst b/docs/drivers/lima.rst index 141c1930f9c..238007431ca 100644 --- a/docs/drivers/lima.rst +++ b/docs/drivers/lima.rst @@ -64,7 +64,7 @@ debugging. None of this is required for normal use. .. envvar:: LIMA_DEBUG ("") -accepts the following comma-separated list of flags: + accepts the following comma-separated list of flags: ``bocache`` print debug info for BO cache @@ -94,19 +94,19 @@ accepts the following comma-separated list of flags: .. envvar:: LIMA_CTX_NUM_PLB (None) -set number of PLB per context (used for development purposes) + set number of PLB per context (used for development purposes) .. envvar:: LIMA_PLB_MAX_BLK (None) -set PLB max block (used for development purposes) + set PLB max block (used for development purposes) .. envvar:: LIMA_PPIR_FORCE_SPILLING (None) -force spilling of variables in PPIR (used for development purposes) + force spilling of variables in PPIR (used for development purposes) .. envvar:: LIMA_PLB_PP_STREAM_CACHE_SIZE (None) -set PP stream cache size (used for development purposes) + set PP stream cache size (used for development purposes) Known hardware limitations -------------------------- diff --git a/docs/drivers/zink.rst b/docs/drivers/zink.rst index 017a0110efd..9778ef268bc 100644 --- a/docs/drivers/zink.rst +++ b/docs/drivers/zink.rst @@ -255,23 +255,23 @@ variable: .. envvar:: ZINK_DEBUG ("") -``nir`` - Print the NIR form of all shaders to stderr. -``spirv`` - Write the binary SPIR-V form of all compiled shaders to a file in the - current directory, and print a message with the filename to stderr. -``tgsi`` - Print the TGSI form of TGSI shaders to stderr. -``validation`` - Dump Validation layer output. -``sync`` - Emit full synchronization barriers before every draw and dispatch. -``compact`` - Use a maximum of 4 descriptor sets -``noreorder`` - Do not reorder or optimize GL command streams -``gpl`` - Force using Graphics Pipeline Library for all shaders + ``nir`` + Print the NIR form of all shaders to stderr. + ``spirv`` + Write the binary SPIR-V form of all compiled shaders to a file in the + current directory, and print a message with the filename to stderr. + ``tgsi`` + Print the TGSI form of TGSI shaders to stderr. + ``validation`` + Dump Validation layer output. + ``sync`` + Emit full synchronization barriers before every draw and dispatch. + ``compact`` + Use a maximum of 4 descriptor sets + ``noreorder`` + Do not reorder or optimize GL command streams + ``gpl`` + Force using Graphics Pipeline Library for all shaders Vulkan Validation Layers ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/gallium/debugging.rst b/docs/gallium/debugging.rst index a567c09d115..1d3aa064cd8 100644 --- a/docs/gallium/debugging.rst +++ b/docs/gallium/debugging.rst @@ -17,42 +17,42 @@ Common .. envvar:: GALLIUM_PRINT_OPTIONS (false) -This option controls if the debug variables should be printed to stderr. This -is probably the most useful variable, since it allows you to find which -variables a driver uses. + This option controls if the debug variables should be printed to stderr. This + is probably the most useful variable, since it allows you to find which + variables a driver uses. .. envvar:: GALLIUM_TRACE ("") -If set, this variable will cause the :ref:`trace` output to be written to the -specified file. Paths may be relative or absolute; relative paths are relative -to the working directory. For example, setting it to "trace.xml" will cause -the trace to be written to a file of the same name in the working directory. + If set, this variable will cause the :ref:`trace` output to be written to the + specified file. Paths may be relative or absolute; relative paths are relative + to the working directory. For example, setting it to "trace.xml" will cause + the trace to be written to a file of the same name in the working directory. .. envvar:: GALLIUM_TRACE_TC (false) -If enabled while :ref:`trace` is active, this variable specifies that the threaded context -should be traced for drivers which implement it. By default, the driver thread is traced, -which will include any reordering of the command stream from threaded context. + If enabled while :ref:`trace` is active, this variable specifies that the threaded context + should be traced for drivers which implement it. By default, the driver thread is traced, + which will include any reordering of the command stream from threaded context. .. envvar:: GALLIUM_TRACE_TRIGGER ("") -If set while :ref:`trace` is active, this variable specifies a filename to monitor. -Once the file exists (e.g., from the user running 'touch /path/to/file'), a single -frame will be recorded into the trace output. -Paths may be relative or absolute; relative paths are relative to the working directory. + If set while :ref:`trace` is active, this variable specifies a filename to monitor. + Once the file exists (e.g., from the user running 'touch /path/to/file'), a single + frame will be recorded into the trace output. + Paths may be relative or absolute; relative paths are relative to the working directory. .. envvar:: GALLIUM_DUMP_CPU (false) -Dump information about the current CPU that the driver is running on. + Dump information about the current CPU that the driver is running on. .. envvar:: TGSI_PRINT_SANITY (false) -Gallium has a built-in shader sanity checker. This option controls whether -the shader sanity checker prints its warnings and errors to stderr. + Gallium has a built-in shader sanity checker. This option controls whether + the shader sanity checker prints its warnings and errors to stderr. .. envvar:: DRAW_USE_LLVM (false) -Whether the :ref:`Draw` module will attempt to use LLVM for vertex and geometry shaders. + Whether the :ref:`Draw` module will attempt to use LLVM for vertex and geometry shaders. GL State tracker-specific @@ -60,7 +60,7 @@ GL State tracker-specific .. envvar:: ST_DEBUG (0x0) -Debug :ref:`flags` for the GL state tracker. + Debug :ref:`flags` for the GL state tracker. Driver-specific @@ -68,27 +68,27 @@ Driver-specific .. envvar:: I915_DEBUG (0x0) -Debug :ref:`flags` for the i915 driver. + Debug :ref:`flags` for the i915 driver. .. envvar:: I915_NO_HW (false) -Stop the i915 driver from submitting commands to the hardware. + Stop the i915 driver from submitting commands to the hardware. .. envvar:: I915_DUMP_CMD (false) -Dump all commands going to the hardware. + Dump all commands going to the hardware. .. envvar:: LP_DEBUG (0x0) -Debug :ref:`flags` for the LLVMpipe driver. + Debug :ref:`flags` for the LLVMpipe driver. .. envvar:: LP_NUM_THREADS (number of CPUs) -Number of threads that the LLVMpipe driver should use. + Number of threads that the LLVMpipe driver should use. .. envvar:: FD_MESA_DEBUG (0x0) -Debug :ref:`flags` for the Freedreno driver. + Debug :ref:`flags` for the Freedreno driver. .. _flags: diff --git a/docs/u_trace.rst b/docs/u_trace.rst index 834d9931373..9e8acdfc131 100644 --- a/docs/u_trace.rst +++ b/docs/u_trace.rst @@ -53,15 +53,15 @@ u_trace is controlled by environment variables: ``TU_GPU_TRACEPOINT=-blit,+render_pass`` will disable the ``blit`` tracepoints and enable the ``render_pass`` tracepoints. -.. list-table:: - :header-rows: 1 + .. list-table:: + :header-rows: 1 - * - Driver - - Environment Variable - - Tracepoint Definitions - * - Freedreno - - :envvar:`FD_GPU_TRACEPOINT` - - ``src/gallium/drivers/freedreno/freedreno_tracepoints.py`` - * - Turnip - - :envvar:`TU_GPU_TRACEPOINT` - - ``src/freedreno/vulkan/tu_tracepoints.py`` + * - Driver + - Environment Variable + - Tracepoint Definitions + * - Freedreno + - :envvar:`FD_GPU_TRACEPOINT` + - ``src/gallium/drivers/freedreno/freedreno_tracepoints.py`` + * - Turnip + - :envvar:`TU_GPU_TRACEPOINT` + - ``src/freedreno/vulkan/tu_tracepoints.py``