From e8d5e7c4bb11f7fcb0a4ba5c13f43e7929849a2f Mon Sep 17 00:00:00 2001
From: marha
-To add a new GL extension to Mesa you have to do at least the following.
-
-Mesa's code style has changed over the years. Here's the latest.
+Mesa is over 20 years old and the coding style has evolved over time.
+Some old parts use a style that's a bit out of date.
+If the guidelines below don't cover something, try following the format of
+existing, neighboring code.
-Comment your code! It's extremely important that open-source code be
-well documented. Also, strive to write clean, easily understandable code.
+Basic formatting guidelines
-3-space indentation
-
-If you use tabs, set them to 8 columns
-
-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).
-
-Brace example:
-
-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)
-
-Local variable name example: localVarName (no underscores)
-
-Constants and macros are ALL_UPPERCASE, with _ between words
-
-Global variables are not allowed.
+The basic guidelines for submitting patches are:
-Function name examples:
+The basic rules for patch formatting are:
-Places that are not directly visible to the GL API should prefer the use
-of bool, true, and
-false over GLboolean, GL_TRUE, and
-GL_FALSE. In C code, this may mean that
-#include <stdbool.h> needs to be added. The
-try_emit_* methods in src/mesa/program/ir_to_mesa.cpp and
-src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
+It should go without saying that patches must be tested. In general,
+do whatever testing is prudent.
-You should always run the Mesa Testsuite before submitting patches.
-The Testsuite can be run using the 'make check' command. All tests
+You should always run the Mesa test suite before submitting patches.
+The test suite can be run using the 'make check' command. All tests
must pass before patches will be accepted, this may mean you have
to update the tests themselves.
+Whenever possible and applicable, test the patch with
+Piglit to
+check for regressions.
+
Patches should be sent to the Mesa mailing list for review.
When submitting a patch make sure to use git send-email rather than attaching
@@ -184,7 +266,32 @@ re-sending the whole series). Using --in-reply-to makes
it harder for reviewers to accidentally review old patches.
+When you've reviewed a patch on the mailing list, please be unambiguous
+about your review. That is, state either
+Development Notes
-Adding Extensions
-
-
-
-
-
- #ifndef GL_EXT_the_extension_name
- #define GL_EXT_the_extension_name 1
- /* declare the new enum tokens */
- /* prototype the new functions */
- /* TYPEDEFS for the new functions */
- #endif
-
-gl_extensions
struct in mtypes.h
-extensions.c
file.
-Coding Style
+Coding Style
+
+
+
+
+ if (condition) {
+ foo;
+ } else {
+ bar;
+ }
+
-
+ indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
+
-
+
+Single-line comments:
+
+ /* null-out pointer to prevent dangling reference below */
+ bufferObj = NULL;
+
+Or,
+
+ bufferObj = NULL; /* prevent dangling reference below */
+
+Multi-line comment:
- if (condition) {
- foo;
- }
- else {
- bar;
- }
-
- switch (condition) {
- case 0:
- foo();
- break;
-
- case 1: {
- ...
- break;
- }
-
- default:
- ...
- break;
- }
+ /* If this is a new buffer object id, or one which was generated but
+ * never used before, allocate a buffer object now.
+ */
+
+We try to quote the OpenGL specification where prudent:
+
+ /* Page 38 of the PDF of the OpenGL ES 3.0 spec says:
+ *
+ * "An INVALID_OPERATION error is generated for any of the following
+ * conditions:
+ *
+ * *
+Function comment example:
+
+ /**
+ * Create and initialize a new buffer object. Called via the
+ * ctx->Driver.CreateObject() driver callback function.
+ * \param name integer name of the object
+ * \param type one of GL_FOO, GL_BAR, etc.
+ * \return pointer to new object or NULL if error
+ */
+ struct gl_object *
+ _mesa_create_object(GLuint name, GLenum type)
+ {
+ /* function body */
+ }
-grep ^function_name dir/*
to find function definitions. Also,
+the opening brace goes on the next line by itself (see above.)
+
+
- indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
+ glFooBar() - a public GL entry point (in glapi_dispatch.c)
+ _mesa_FooBar() - the internal immediate mode function
+ save_FooBar() - retained mode (display list) function in dlist.c
+ foo_bar() - a static (private) function
+ _mesa_foo_bar() - an internal non-static Mesa function
+Submitting patches
+
+
+git bisect
.)
+git send-email
.
+Patch formatting
+
+
+
+
+
+
+ mesa: Add support for querying GL_VERTEX_ATTRIB_ARRAY_LONG
+
+ gallium: add PIPE_CAP_DEVICE_RESET_STATUS_QUERY
+
+ i965: Fix missing type in local variable declaration.
+
+
+ i965: Remove end-of-thread SEND alignment code.
+
+ This was present in Eric's initial implementation of the compaction code
+ for Sandybridge (commit 077d01b6). There is no documentation saying this
+ is necessary, and removing it causes no regressions in piglit on any
+ platform.
+
+
+ Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=89689
+
+
- glFooBar() - a public GL entry point (in glapi_dispatch.c)
- _mesa_FooBar() - the internal immediate mode function
- save_FooBar() - retained mode (display list) function in dlist.c
- foo_bar() - a static (private) function
- _mesa_foo_bar() - an internal non-static Mesa function
+ st/mesa: add ARB_texture_stencil8 support (v4)
+
+ if we support stencil texturing, enable texture_stencil8
+ there is no requirement to support native S8 for this,
+ the texture can be converted to x24s8 fine.
+
+ v2: fold fixes from Marek in:
+ a) put S8 last in the list
+ b) fix renderable to always test for d/s renderable
+ fixup the texture case to use a stencil only format
+ for picking the format for the texture view.
+ v3: hit fallback for getteximage
+ v4: put s8 back in front, it shouldn't get picked now (Ilia)
+
+ Tested-by: Joe Hacker <jhacker@foo.com>
+
+
+ Reviewed-by: Joe Hacker <jhacker@foo.com>
+ Acked-by: Joe Hacker <jhacker@foo.com>
+
+Testing Patches
Submitting patches
-
Mailing Patches
+
Marking a commit as a candidate for a stable branch
+Reviewing Patches
+
+
+ Reviewed-by: Joe Hacker <jhacker@foo.com>
+
+or
+
+ Acked-by: Joe Hacker <jhacker@foo.com>
+
+Rather than saying just "LGTM" or "Seems OK".
+
+If small changes are suggested, it's OK to say something like: +
+ With the above fixes, Reviewed-by: Joe Hacker <jhacker@foo.com> ++which tells the patch author that the patch can be committed, as long +as the issues are resolved first. + + + +
If you want a commit to be applied to a stable branch, @@ -221,7 +328,7 @@ the upcoming stable release can always be seen on the Mesa Stable Queue page. -
These are the instructions for making a new Mesa release. @@ -456,7 +564,7 @@ Edit docs/relnotes/X.Y.Z.html to add the sha256sums printed as part of "make tarballs" in the previous step. Commit this change.
-This is the first step that cannot easily be undone. The release is going @@ -483,7 +591,7 @@ signatures to the freedesktop.org server: mv ~/MesaLib-X.Y.Z* . -
Something like the following steps will do the trick: @@ -543,6 +651,56 @@ release announcement:
+ ++To add a new GL extension to Mesa you have to do at least the following. + +
+ #ifndef GL_EXT_the_extension_name + #define GL_EXT_the_extension_name 1 + /* declare the new enum tokens */ + /* prototype the new functions */ + /* TYPEDEFS for the new functions */ + #endif ++
gl_extensions
struct in mtypes.h
+extensions.c
file.
+