diff options
Diffstat (limited to 'docs/devinfo.html')
| -rw-r--r-- | docs/devinfo.html | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/devinfo.html b/docs/devinfo.html index 8887dd02624..d9e82e29d0b 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -72,6 +72,13 @@ If you use tabs, set them to 8 columns </p> <p> +Line width: the preferred width to fill comments and code in Mesa is 78 +columns. Exceptions are sometimes made for clarity (e.g. tabular data is +sometimes filled to a much larger width so that extraneous carriage returns +don't obscure the table). +</p> + +<p> Brace example: </p> <pre> @@ -81,10 +88,26 @@ Brace example: else { bar; } + + switch (condition) { + case 0: + foo(); + break; + + case 1: { + ... + break; + } + + default: + ... + break; + } </pre> <p> Here's the GNU indent command which will best approximate my preferred style: +(Note that it won't format switch statements in the preferred way) </p> <pre> indent -br -i3 -npcs --no-tabs infile.c -o outfile.c @@ -114,6 +137,16 @@ Function name examples: _mesa_foo_bar() - an internal non-static Mesa function </pre> +<p> +Places that are not directly visible to the GL API should prefer the use +of <tt>bool</tt>, <tt>true</tt>, and +<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and +<tt>GL_FALSE</tt>. In C code, this may mean that +<tt>#include <stdbool.h></tt> need to be added. The +<tt>try_emit_</tt>* methods in src/mesa/program/ir_to_mesa.cpp and +src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as an example. +</p> + <H2>Making a New Mesa Release</H2> |