glsl: Explain file naming convention

1 files changed, 12 insertions, 0 deletions

diff --git a/src/glsl/README b/src/glsl/README
index 62742bf1396..dd80a53d476 100644
--- a/src/glsl/README
+++ b/src/glsl/README
@@ -215,3 +215,15 @@ talloc_parent() call is expensive, so many passes will cache the
 result of the first talloc_parent().  Cleaning up all the optimization
 passes to take a context argument and not call talloc_parent() is left
 as an exercise.
+
+Q: What is the file naming convention in this directory?
+
+Initially, there really wasn't one.  We have since adopted one:
+
+ - Files that implement code lowering passes should be named lower_*
+   (e.g., lower_noise.cpp).
+ - Files that implement optimization passes should be named opt_*.
+ - Files that implement a class that is used throught the code should
+   take the name of that class (e.g., ir_hierarchical_visitor.cpp).
+ - Files that contain code not fitting in one of the previous
+   categories should have a sensible name (e.g., glsl_parser.ypp).