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 <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
This commit is contained in:
Erik Faye-Lund
2022-11-08 11:10:45 +01:00
parent e7e92f7954
commit c70c5ecd2e
3 changed files with 54 additions and 63 deletions

View File

@@ -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.