summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorIan Romanick <ian.d.romanick@intel.com>2010-09-13 13:46:29 -0700
committerIan Romanick <ian.d.romanick@intel.com>2010-09-13 14:06:32 -0700
commite79a1bb02a0ce3c265c4a64c117018a9207064c9 (patch)
treefe9b08688d2eb486a5eb0918f685978dcf1533ad /src
parent710d41131b9715c5c378e0138d991f346647b9c8 (diff)
glsl: Explain file naming convention
Diffstat (limited to 'src')
-rw-r--r--src/glsl/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/glsl/README b/src/glsl/README
index 62742bf139..dd80a53d47 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).