glx: drop misleading comment about the file being "generated"

[mesa.git] / docs / envvars.html

diff --git a/docs/envvars.html b/docs/envvars.html
index c41820b8d39151184dbb8e281293f848cec32e22..92f9207c80e145168abd87e85a16bf85cdc30f0b 100644 (file)
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -133,13 +133,14 @@ sometimes be useful for debugging end-user issues.
     <dt><code>3.0FC</code></dt>
     <dd>select a Core+Forward Compatible profile with GL version 3.0.</dd>
     <dt><code>3.1</code></dt>
-    <dd>select GL version 3.1 with GL_ARB_compatibility enabled per the
-        driver default.</dd>
+    <dd>select GL version 3.1 with <code>GL_ARB_compatibility</code>
+        enabled per the driver default.</dd>
     <dt><code>3.1FC</code></dt>
     <dd>select GL version 3.1 with forward compatibility and
-        GL_ARB_compatibility disabled.</dd>
+        <code>GL_ARB_compatibility</code> disabled.</dd>
     <dt><code>3.1COMPAT</code></dt>
-    <dd>select GL version 3.1 with GL_ARB_compatibility enabled.</dd>
+    <dd>select GL version 3.1 with <code>GL_ARB_compatibility</code>
+        enabled.</dd>
     <dt><code>X.Y</code></dt>
     <dd>override GL version to X.Y without changing the profile.</dd>
     <dt><code>X.YFC</code></dt>
@@ -164,9 +165,9 @@ sometimes be useful for debugging end-user issues.
 <dt><code>MESA_GLSL_VERSION_OVERRIDE</code></dt>
 <dd>changes the value returned by
     <code>glGetString(GL_SHADING_LANGUAGE_VERSION)</code>.
-    Valid values are integers, such as "130".  Mesa will not really implement
-    all the features of the given language version if it's higher than what's
-    normally reported. (for developers only)
+    Valid values are integers, such as <code>130</code>.  Mesa will not
+    really implement all the features of the given language version if
+    it's higher than what's normally reported. (for developers only)
 </dd>
 <dt><code>MESA_GLSL_CACHE_DISABLE</code></dt>
 <dd>if set to <code>true</code>, disables the GLSL shader cache</dd>
@@ -200,7 +201,7 @@ sometimes be useful for debugging end-user issues.
   <ul>
     <li>The format should be <code>MAJOR.MINOR[.PATCH]</code></li>
     <li>This will not let you force a version higher than the driver's
-        instance versionas advertised by
+        instance version as advertised by
         <code>vkEnumerateInstanceVersion</code></li>
     <li>This can be very useful for debugging but some features may not be
         implemented correctly. (For developers only)</li>
@@ -209,6 +210,23 @@ sometimes be useful for debugging end-user issues.
 </dl>
 
 
+<h2>NIR passes enviroment variables</h2>
+<p>
+The following are only applicable for drivers that uses NIR, as they
+modify the behaviour for the common NIR_PASS and NIR_PASS_V macros,
+that wrap calls to NIR lowering/optimizations.
+</p>
+
+<dl>
+  <dt><code>NIR_PRINT</code></dt>
+  <dd>If defined, the resulting NIR shader will be printed out at each succesful NIR lowering/optimization call.</dd>
+  <dt><code>NIR_TEST_CLONE</code></dt>
+  <dd>If defined, cloning a NIR shader would be tested at each succesful NIR lowering/optimization call.</dd>
+  <dt><code>NIR_TEST_SERIALIZE</code></dt>
+  <dd>If defined, serialize and deserialize a NIR shader would be tested at each succesful NIR lowering/optimization call.</dd>
+</dl>
+
+
 <h2>Mesa Xlib driver environment variables</h2>
 
 <p>
@@ -362,8 +380,8 @@ Mesa EGL supports different sets of environment variables.  See the
 <dt><code>GALLIUM_HUD</code></dt>
 <dd>draws various information on the screen, like framerate,
     cpu load, driver statistics, performance counters, etc.
-    Set <code>GALLIUM_HUD=help</code> and run e.g. glxgears for more
-    info.</dd>
+    Set <code>GALLIUM_HUD=help</code> and run e.g.
+    <code>glxgears</code> for more info.</dd>
 <dt><code>GALLIUM_HUD_PERIOD</code></dt>
 <dd>sets the hud update rate in seconds (float). Use zero
     to update every frame. The default period is 1/2 second.</dd>
@@ -467,12 +485,12 @@ Mesa EGL supports different sets of environment variables.  See the
 <dd>for dumping shaders, constant buffers, etc.  See the code for
     details.</dd>
 <dt><code>SVGA_EXTRA_LOGGING</code></dt>
-<dd>if set, enables extra logging to the vmware.log file, such as the
-    OpenGL program's name and command line arguments.</dd>
+<dd>if set, enables extra logging to the <code>vmware.log</code> file,
+    such as the OpenGL program's name and command line arguments.</dd>
 <dt><code>SVGA_NO_LOGGING</code></dt>
-<dd>if set, disables logging to the vmware.log file. This is useful when
-    using Valgrind because it otherwise crashes when initializing the host
-    log feature.</dd>
+<dd>if set, disables logging to the <code>vmware.log</code> file. This is
+    useful when using Valgrind because it otherwise crashes when
+    initializing the host log feature.</dd>
 </dl>
 <p>See the driver code for other, lesser-used variables.</p>