From c70c5ecd2e7bb04729628630aebf0574f7f19c1c Mon Sep 17 00:00:00 2001 From: Erik Faye-Lund Date: Tue, 8 Nov 2022 11:10:45 +0100 Subject: [PATCH] docs: move generic gallium envvars to root doc It makes little sense to document the gallium envvars in multiple places. Let's merge them all into the root envvar document. This also moves GALLIUM_OVERRIDE_CPU_CAPS to toe root envvars doc, as it's more generic than just LLVMpipe. Reviewed-by: Yonggang Luo Part-of: --- docs/drivers/llvmpipe.rst | 11 -------- docs/envvars.rst | 53 ++++++++++++++++++++++++++++++++++++++ docs/gallium/debugging.rst | 53 +------------------------------------- 3 files changed, 54 insertions(+), 63 deletions(-) diff --git a/docs/drivers/llvmpipe.rst b/docs/drivers/llvmpipe.rst index 9884b1889d8..c89868343b4 100644 --- a/docs/drivers/llvmpipe.rst +++ b/docs/drivers/llvmpipe.rst @@ -96,17 +96,6 @@ Environment variables out LLVMpipe can be fastest by using 128 bit vectors, yet use AVX instructions. -.. envvar:: GALLIUM_OVERRIDE_CPU_CAPS - - Override CPU capabilities for LLVMpipe and Softpipe, possible values for x86: - ``nosse`` - ``sse`` - ``sse2`` - ``sse3`` - ``ssse3`` - ``sse4.1`` - ``avx`` - .. envvar:: GALLIUM_NOSSE Deprecated in favor of ``GALLIUM_OVERRIDE_CPU_CAPS``, diff --git a/docs/envvars.rst b/docs/envvars.rst index 496a4cfa8e6..e3af628118c 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -635,6 +635,26 @@ Gallium environment variables if non-zero, print all the Gallium environment variables which are used, and their current values. +.. 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. + +.. envvar:: GALLIUM_TRACE_TC + + 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. + .. envvar:: GALLIUM_DUMP_CPU if non-zero, print information about the CPU on start-up @@ -664,6 +684,17 @@ Gallium environment variables ``tgsi``, for example, will print all the TGSI shaders. See :file:`src/mesa/state_tracker/st_debug.c` for other options. +.. envvar:: GALLIUM_OVERRIDE_CPU_CAPS + + Override CPU capabilities for LLVMpipe and Softpipe, possible values for x86: + ``nosse`` + ``sse`` + ``sse2`` + ``sse3`` + ``ssse3`` + ``sse4.1`` + ``avx`` + Clover environment variables ---------------------------- @@ -1402,3 +1433,25 @@ Asahi driver environment variables Other Gallium drivers have their own environment variables. These may change frequently so the source code should be consulted for details. + +i915 driver environment variables +--------------------------------- + +.. envvar:: I915_DEBUG + + Debug flags for the i915 driver. + +.. envvar:: I915_NO_HW + + Stop the i915 driver from submitting commands to the hardware. + +.. envvar:: I915_DUMP_CMD + + Dump all commands going to the hardware. + +Freedreno driver environment variables +-------------------------------------- + +.. envvar:: FD_MESA_DEBUG + + Debug flags for the Freedreno driver. diff --git a/docs/gallium/debugging.rst b/docs/gallium/debugging.rst index e3d258a5599..2145b569240 100644 --- a/docs/gallium/debugging.rst +++ b/docs/gallium/debugging.rst @@ -12,55 +12,4 @@ the platform or operating system you are running. For example, for Linux this can be done by typing "export var=value" into a console and then running the program from that console. -Common -"""""" - -.. 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. - -.. envvar:: GALLIUM_TRACE_TC - - 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. - -Driver-specific -""""""""""""""" - -.. envvar:: I915_DEBUG - - Debug :ref:`flags` for the i915 driver. - -.. envvar:: I915_NO_HW - - Stop the i915 driver from submitting commands to the hardware. - -.. envvar:: I915_DUMP_CMD - - Dump all commands going to the hardware. - -.. envvar:: FD_MESA_DEBUG - - Debug :ref:`flags` for the Freedreno driver. - - -.. _flags: - -Flags -""""" - -The variables of type "flags" all take a string with comma-separated flags to -enable different debugging for different parts of the drivers or state -tracker. If set to "help", the driver will print a list of flags which the -variable accepts. Order does not matter. +See :doc:`../envvars` for details.