From: Ian Romanick <ian.d.roman...@intel.com> Signed-off-by: Ian Romanick <ian.d.roman...@intel.com> Cc: Paul Berry <stereotype...@gmail.com> Cc: Brian Paul <bri...@vmware.com> --- docs/devinfo.html | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+)
diff --git a/docs/devinfo.html b/docs/devinfo.html index 8f4aeef..eb4c897 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -155,6 +155,48 @@ of <tt>bool</tt>, <tt>true</tt>, and src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples. </p> +<p> +It is often useful to quote sections from relevant specifications near +code that implements part of the spec. In order to make it easier to +find such quotations in the code (via grep and friends) and to find the +quoted text in the specifications, please use one of the following +formats. +</p> + +<p> +Text quoted from the core OpenGL or OpenGL ES specifications: +</p> + +<pre> + /* Page AA (page BB of the PDF) in section C.D.E of the OpenGL F.G + * specification says: + * + * "Some quoted text from the specificiation" + */ +</pre> + +<p> +Text quoted from the GLSL or GLSL ES ES specifications: +</p> + +<pre> + /* Page AA (page BB of the PDF) in section C.D.E of the GLSL F.G + * specification says: + * + * "Some quoted text from the specificiation" + */ +</pre> + +<p> +Text quoted from an extension specifications: +</p> + +<pre> + /* Section C.D.E of the GL_EXT_foo_bar specification says: + * + * "Some quoted text from the specificiation" + */ +</pre> <h2>Marking a commit as a candidate for a stable branch</h2> -- 1.7.11.7 _______________________________________________ mesa-dev mailing list mesa-dev@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/mesa-dev
