diff options
author | Erik Faye-Lund <erik.faye-lund@collabora.com> | 2022-11-08 10:24:07 +0100 |
---|---|---|
committer | Erik Faye-Lund <erik.faye-lund@collabora.com> | 2022-11-15 11:25:05 +0100 |
commit | 4eef5628c86e930c48f90cdcbe51bf5a3651c4c4 (patch) | |
tree | 81e248e0a17e9305151fc60a92d117f12c4b6d83 /docs/gallium | |
parent | 864e658c0a069026c1f123079cfb09ecc4cf06cf (diff) | |
download | mesa-4eef5628c86e930c48f90cdcbe51bf5a3651c4c4.tar.gz |
docs: drop custom envvar directive
The custom envvar directive is strange. It overloads the global
namespace, where there's already a well-known envvar directive, but the
envvar role won't resolve to envvars defined using the custom directive.
It's not really critical to declare the type and default value here, and
many descriptions already include this. Let's just use the plain one,
and let the description take care of the details where needed.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
Diffstat (limited to 'docs/gallium')
-rw-r--r-- | docs/gallium/debugging.rst | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/gallium/debugging.rst b/docs/gallium/debugging.rst index 1d3aa064cd8..801e87f99c5 100644 --- a/docs/gallium/debugging.rst +++ b/docs/gallium/debugging.rst @@ -15,42 +15,42 @@ program from that console. Common """""" -.. envvar:: GALLIUM_PRINT_OPTIONS <bool> (false) +.. envvar:: GALLIUM_PRINT_OPTIONS - 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 boolean 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 <string> ("") +.. 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 <bool> (false) +.. 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 <string> ("") +.. 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 <bool> (false) +.. envvar:: GALLIUM_DUMP_CPU - Dump information about the current CPU that the driver is running on. + Enable dumping of information about the current CPU that the driver is running on. -.. envvar:: TGSI_PRINT_SANITY <bool> (false) +.. envvar:: TGSI_PRINT_SANITY - 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 boolean option controls + whether the shader sanity checker prints its warnings and errors to stderr. -.. envvar:: DRAW_USE_LLVM <bool> (false) +.. envvar:: DRAW_USE_LLVM Whether the :ref:`Draw` module will attempt to use LLVM for vertex and geometry shaders. @@ -58,7 +58,7 @@ Common GL State tracker-specific """"""""""""""""""""""""" -.. envvar:: ST_DEBUG <flags> (0x0) +.. envvar:: ST_DEBUG Debug :ref:`flags` for the GL state tracker. @@ -66,27 +66,27 @@ GL State tracker-specific Driver-specific """"""""""""""" -.. envvar:: I915_DEBUG <flags> (0x0) +.. envvar:: I915_DEBUG Debug :ref:`flags` for the i915 driver. -.. envvar:: I915_NO_HW <bool> (false) +.. envvar:: I915_NO_HW Stop the i915 driver from submitting commands to the hardware. -.. envvar:: I915_DUMP_CMD <bool> (false) +.. envvar:: I915_DUMP_CMD Dump all commands going to the hardware. -.. envvar:: LP_DEBUG <flags> (0x0) +.. envvar:: LP_DEBUG Debug :ref:`flags` for the LLVMpipe driver. -.. envvar:: LP_NUM_THREADS <int> (number of CPUs) +.. envvar:: LP_NUM_THREADS Number of threads that the LLVMpipe driver should use. -.. envvar:: FD_MESA_DEBUG <flags> (0x0) +.. envvar:: FD_MESA_DEBUG Debug :ref:`flags` for the Freedreno driver. |