1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <meta http-equiv=
"content-type" content=
"text/html; charset=utf-8">
5 <title>Development Notes
</title>
6 <link rel=
"stylesheet" type=
"text/css" href=
"mesa.css">
11 <h1>The Mesa
3D Graphics Library
</h1>
14 <iframe src=
"contents.html"></iframe>
17 <h1>Development Notes
</h1>
20 <h2>Adding Extensions
</h2>
23 To add a new GL extension to Mesa you have to do at least the following.
27 If glext.h doesn't define the extension, edit include/GL/gl.h and add
30 #ifndef GL_EXT_the_extension_name
31 #define GL_EXT_the_extension_name
1
32 /* declare the new enum tokens */
33 /* prototype the new functions */
34 /* TYPEDEFS for the new functions */
39 In the src/mapi/glapi/gen/ directory, add the new extension functions and
40 enums to the gl_API.xml file.
41 Then, a bunch of source files must be regenerated by executing the
42 corresponding Python scripts.
45 Add a new entry to the
<code>gl_extensions
</code> struct in mtypes.h
48 Update the
<code>extensions.c
</code> file.
51 From this point, the best way to proceed is to find another extension,
52 similar to the new one, that's already implemented in Mesa and use it
56 If the new extension adds new GL state, the functions in get.c, enable.c
57 and attrib.c will most likely require new code.
66 Mesa's code style has changed over the years. Here's the latest.
70 Comment your code! It's extremely important that open-source code be
71 well documented. Also, strive to write clean, easily understandable code.
79 If you use tabs, set them to
8 columns
83 Line width: the preferred width to fill comments and code in Mesa is
78
84 columns. Exceptions are sometimes made for clarity (e.g. tabular data is
85 sometimes filled to a much larger width so that extraneous carriage returns
86 don't obscure the table).
117 Here's the GNU indent command which will best approximate my preferred style:
118 (Note that it won't format switch statements in the preferred way)
121 indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
126 Local variable name example: localVarName (no underscores)
130 Constants and macros are ALL_UPPERCASE, with _ between words
134 Global variables are not allowed.
138 Function name examples:
141 glFooBar() - a public GL entry point (in glapi_dispatch.c)
142 _mesa_FooBar() - the internal immediate mode function
143 save_FooBar() - retained mode (display list) function in dlist.c
144 foo_bar() - a static (private) function
145 _mesa_foo_bar() - an internal non-static Mesa function
149 Places that are not directly visible to the GL API should prefer the use
150 of
<tt>bool
</tt>,
<tt>true
</tt>, and
151 <tt>false
</tt> over
<tt>GLboolean
</tt>,
<tt>GL_TRUE
</tt>, and
152 <tt>GL_FALSE
</tt>. In C code, this may mean that
153 <tt>#include
<stdbool.h
></tt> needs to be added. The
154 <tt>try_emit_
</tt>* methods in src/mesa/program/ir_to_mesa.cpp and
155 src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
158 <h2>Submitting patches
</h2>
161 You should always run the Mesa Testsuite before submitting patches.
162 The Testsuite can be run using the 'make check' command. All tests
163 must pass before patches will be accepted, this may mean you have
164 to update the tests themselves.
168 Patches should be sent to the Mesa mailing list for review.
169 When submitting a patch make sure to use git send-email rather than attaching
170 patches to emails. Sending patches as attachments prevents people from being
171 able to provide in-line review comments.
175 When submitting follow-up patches you can use --in-reply-to to make v2, v3,
176 etc patches show up as replies to the originals. This usually works well
177 when you're sending out updates to individual patches (as opposed to
178 re-sending the whole series). Using --in-reply-to makes
179 it harder for reviewers to accidentally review old patches.
182 <h2>Marking a commit as a candidate for a stable branch
</h2>
185 If you want a commit to be applied to a stable branch,
186 you should add an appropriate note to the commit message.
190 Here are some examples of such a note:
193 <li>CC:
<mesa-stable@lists.freedesktop.org
></li>
194 <li>CC:
"9.2 10.0" <mesa-stable@lists.freedesktop.org
></li>
195 <li>CC:
"10.0" <mesa-stable@lists.freedesktop.org
></li>
198 Simply adding the CC to the mesa-stable list address is adequate to nominate
199 the commit for the most-recently-created stable branch. It is only necessary
200 to specify a specific branch name, (such as
"9.2 10.0" or
"10.0" in the
201 examples above), if you want to nominate the commit for an older stable
202 branch. And, as in these examples, you can nominate the commit for the older
203 branch in addition to the more recent branch, or nominate the commit
204 exclusively for the older branch.
206 This
"CC" syntax for patch nomination will cause patches to automatically be
207 copied to the mesa-stable@ mailing list when you use
"git send-email" to send
208 patches to the mesa-dev@ mailing list. Also, if you realize that a commit
209 should be nominated for the stable branch after it has already been committed,
210 you can send a note directly to the mesa-stable@lists.freedesktop.org where
211 the Mesa stable-branch maintainers will receive it. Be sure to mention the
212 commit ID of the commit of interest (as it appears in the mesa master branch).
214 <h2>Cherry-picking candidates for a stable branch
</h2>
217 Please use
<code>git cherry-pick -x
<commit
></code> for cherry-picking a commit
218 from master to a stable branch.
221 <h2>Making a New Mesa Release
</h2>
224 These are the instructions for making a new Mesa release.
227 <h3>Get latest source files
</h3>
229 Use git to get the latest Mesa files from the git repository, from whatever
234 <h3>Verify and update version info in VERSION
</h3>
237 Create a docs/relnotes/x.y.z.html file.
238 The bin/bugzilla_mesa.sh and bin/shortlog_mesa.sh scripts can be used to
239 create the HTML-formatted lists of bugfixes and changes to include in the file.
240 Link the new docs/relnotes/x.y.z.html file into the main
<a href=
"relnotes.html">relnotes.html
</a> file.
244 Update
<a href=
"index.html">docs/index.html
</a>.
248 Tag the files with the release name (in the form
<b>mesa-x.y
</b>)
249 with:
<code>git tag -s mesa-x.y -m
"Mesa x.y Release"</code>
250 Then:
<code>git push origin mesa-x.y
</code>
254 <h3>Make the tarballs
</h3>
256 Make the distribution files. From inside the Mesa directory:
263 After the tarballs are created, the md5 checksums for the files will
265 Add them to the docs/relnotes/x.y.html file.
269 Copy the distribution files to a temporary directory, unpack them,
270 compile everything, and run some demos to be sure everything works.
273 <h3>Update the website and announce the release
</h3>
275 Make a new directory for the release on annarchy.freedesktop.org with:
278 mkdir /srv/ftp.freedesktop.org/pub/mesa/x.y
283 Basically, to upload the tarball files with:
286 rsync -avP -e ssh MesaLib-x.y.* USERNAME@annarchy.freedesktop.org:/srv/ftp.freedesktop.org/pub/mesa/x.y/
291 Update the web site by copying the docs/ directory's files to
292 /home/users/b/br/brianp/mesa-www/htdocs/ with:
295 sftp USERNAME,mesa3d@web.sourceforge.net
300 Make an announcement on the mailing lists:
302 <em>mesa-dev@lists.freedesktop.org
</em>,
303 <em>mesa-users@lists.freedesktop.org
</em>
305 <em>mesa-announce@lists.freedesktop.org
</em>