Mesa (master): nir: add comment for loop_unroll pass

[GitLab Mirror]

Module: Mesa
Branch: master
Commit: 228457234c2b986d8acc88f2419e861c391b18e1
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=228457234c2b986d8acc88f2419e861c391b18e1

Author: Rob Clark <robdclark at gmail.com>
Date:   Fri Jun 15 16:12:23 2018 -0400

nir: add comment for loop_unroll pass

Save the next person from digging through the code to figure out what
the indirect_mask parameter actually does.

Signed-off-by: Rob Clark <robdclark at gmail.com>
Reviewed-by: Timothy Arceri <tarceri at itsqueeze.com>

---

 src/compiler/nir/nir_opt_loop_unroll.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/compiler/nir/nir_opt_loop_unroll.c b/src/compiler/nir/nir_opt_loop_unroll.c
index ff27c06cc0..04caa7c346 100644
--- a/src/compiler/nir/nir_opt_loop_unroll.c
+++ b/src/compiler/nir/nir_opt_loop_unroll.c
@@ -578,6 +578,10 @@ nir_opt_loop_unroll_impl(nir_function_impl *impl,
    return progress;
 }
 
+/**
+ * indirect_mask specifies which type of indirectly accessed variables
+ * should force loop unrolling.
+ */
 bool
 nir_opt_loop_unroll(nir_shader *shader, nir_variable_mode indirect_mask)
 {