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>
This commit is contained in:
Erik Faye-Lund
2022-11-08 10:24:07 +01:00
parent 864e658c0a
commit 4eef5628c8
5 changed files with 35 additions and 43 deletions

View File

@@ -15,7 +15,9 @@ Debugging
There's a few tools that are useful for debugging D3D12, such as these
environment variables:
.. envvar:: D3D12_DEBUG <flags> ("")
.. envvar:: D3D12_DEBUG
Accepts the following comma-separated list of flags:
``verbose``
Enable verbose output to stdout
@@ -34,7 +36,9 @@ environment variables:
``gpuvalidator``
Enable `GPU validator`_
.. envvar:: DXIL_DEBUG <flags> ("")
.. envvar:: DXIL_DEBUG
Accepts the following comma-separated list of flags:
``verbose``
Enable verbose output to stdout
@@ -53,7 +57,7 @@ Utilities
Environment variables that control the behavior of the D3D12 driver.
.. envvar:: MESA_D3D12_DEFAULT_ADAPTER_NAME <string> ("")
.. 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

View File

@@ -62,7 +62,7 @@ Environment variables
These are some Lima-specific environment variables that may aid in
debugging. None of this is required for normal use.
.. envvar:: LIMA_DEBUG <flags> ("")
.. envvar:: LIMA_DEBUG
accepts the following comma-separated list of flags:
@@ -92,19 +92,19 @@ debugging. None of this is required for normal use.
disable multi job optimization
.. envvar:: LIMA_CTX_NUM_PLB <int> (None)
.. envvar:: LIMA_CTX_NUM_PLB
set number of PLB per context (used for development purposes)
.. envvar:: LIMA_PLB_MAX_BLK <int> (None)
.. envvar:: LIMA_PLB_MAX_BLK
set PLB max block (used for development purposes)
.. envvar:: LIMA_PPIR_FORCE_SPILLING <int> (None)
.. envvar:: LIMA_PPIR_FORCE_SPILLING
force spilling of variables in PPIR (used for development purposes)
.. envvar:: LIMA_PLB_PP_STREAM_CACHE_SIZE <int> (None)
.. envvar:: LIMA_PLB_PP_STREAM_CACHE_SIZE
set PP stream cache size (used for development purposes)

View File

@@ -253,7 +253,9 @@ Debugging
There's a few tools that are useful for debugging Zink, like this environment
variable:
.. envvar:: ZINK_DEBUG <flags> ("")
.. envvar:: ZINK_DEBUG
Accepts the following comma-separated list of flags:
``nir``
Print the NIR form of all shaders to stderr.