From: Alejandro Piñeiro <apinheiro@igalia.com>
Date: Thu, 13 Jun 2019 11:22:40 +0000 (+0200)
Subject: docs: document three NIR_ envvars
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d317944c245a0400a94380ba064d53aec9c5a452;p=mesa.git

docs: document three NIR_ envvars

Initially I was only interested on documenting NIR_PRINT, as today I
needed to check the code to find this envvar, that at the moment I
vaguely remembered that existed.

As we are here, though, let's just document all of them (assuming that
makes sense).

Reviewed-by: Eric Anholt <eric@anholt.net>
---

diff --git a/docs/envvars.html b/docs/envvars.html
index 5c4ca905e95..92f9207c80e 100644
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -210,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>