Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / c6184f84b7227e1548947e42bca3ff3ddb7e379c / . / docs / devinfo.html
blob: f5113b0bd72a4785d61201b50df93232be245506 [file] [log] [blame]
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
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">
7</head>
8<body>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]9
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]10<div class="header">
11 <h1>The Mesa 3D Graphics Library</h1>
12</div>
13
14<iframe src="contents.html"></iframe>
15<div class="content">
16
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]17<h1>Development Notes</h1>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]18
19
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]20<ul>
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]21<li><a href="#style">Coding Style</a>
22<li><a href="#submitting">Submitting Patches</a>
23<li><a href="#release">Making a New Mesa Release</a>
24<li><a href="#extensions">Adding Extensions</a>
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]25</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]26
27
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]28<h2 id="style">Coding Style</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]29
30<p>
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]31Mesa is over 20 years old and the coding style has evolved over time.
32Some old parts use a style that's a bit out of date.
33If the guidelines below don't cover something, try following the format of
34existing, neighboring code.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]35</p>
36
37<p>
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]38Basic formatting guidelines
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]39</p>
40
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]41<ul>
42<li>3-space indentation, no tabs.
43<li>Limit lines to 78 or fewer characters. The idea is to prevent line
44wrapping in 80-column editors and terminals. There are exceptions, such
45as if you're defining a large, static table of information.
46<li>Opening braces go on the same line as the if/for/while statement.
47For example:
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]48<pre>
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]49 if (condition) {
50 foo;
51 } else {
52 bar;
53 }
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]54</pre>
55
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]56<li>Put a space before/after operators. For example, <tt>a = b + c;</tt>
57and not <tt>a=b+c;</tt>
58
59<li>This GNU indent command generally does the right thing for formatting:
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]60<pre>
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]61 indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]62</pre>
63
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]64<li>Use comments wherever you think it would be helpful for other developers.
65Several specific cases and style examples follow. Note that we roughly
66follow <a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> conventions.
67<br>
68<br>
69Single-line comments:
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]70<pre>
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]71 /* null-out pointer to prevent dangling reference below */
72 bufferObj = NULL;
73</pre>
74Or,
75<pre>
76 bufferObj = NULL; /* prevent dangling reference below */
77</pre>
78Multi-line comment:
79<pre>
80 /* If this is a new buffer object id, or one which was generated but
81 * never used before, allocate a buffer object now.
82 */
83</pre>
84We try to quote the OpenGL specification where prudent:
85<pre>
86 /* Page 38 of the PDF of the OpenGL ES 3.0 spec says:
87 *
88 * "An INVALID_OPERATION error is generated for any of the following
89 * conditions:
90 *
91 * * <length> is zero."
92 *
93 * Additionally, page 94 of the PDF of the OpenGL 4.5 core spec
94 * (30.10.2014) also says this, so it's no longer allowed for desktop GL,
95 * either.
96 */
97</pre>
98Function comment example:
99<pre>
100 /**
101 * Create and initialize a new buffer object. Called via the
102 * ctx->Driver.CreateObject() driver callback function.
103 * \param name integer name of the object
104 * \param type one of GL_FOO, GL_BAR, etc.
105 * \return pointer to new object or NULL if error
106 */
107 struct gl_object *
108 _mesa_create_object(GLuint name, GLenum type)
109 {
110 /* function body */
111 }
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]112</pre>
113
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]114<li>Put the function return type and qualifiers on one line and the function
115name and parameters on the next, as seen above. This makes it easy to use
116<code>grep ^function_name dir/*</code> to find function definitions. Also,
117the opening brace goes on the next line by itself (see above.)
118
119<li>Function names follow various conventions depending on the type of function:
120<pre>
121 glFooBar() - a public GL entry point (in glapi_dispatch.c)
122 _mesa_FooBar() - the internal immediate mode function
123 save_FooBar() - retained mode (display list) function in dlist.c
124 foo_bar() - a static (private) function
125 _mesa_foo_bar() - an internal non-static Mesa function
126</pre>
127
128<li>Constants, macros and enumerant names are ALL_UPPERCASE, with _ between
129words.
130<li>Mesa usually uses camel case for local variables (Ex: "localVarname")
131while gallium typically uses underscores (Ex: "local_var_name").
132<li>Global variables are almost never used because Mesa should be thread-safe.
133
134<li>Booleans. Places that are not directly visible to the GL API
135should prefer the use of <tt>bool</tt>, <tt>true</tt>, and
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]136<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and
137<tt>GL_FALSE</tt>. In C code, this may mean that
Kai Wasserbäche106d4c2011-08-27 17:51:47 +0200[diff] [blame]138<tt>#include &lt;stdbool.h&gt;</tt> needs to be added. The
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]139<tt>try_emit_</tt>* methods in src/mesa/program/ir_to_mesa.cpp and
Kai Wasserbäche106d4c2011-08-27 17:51:47 +0200[diff] [blame]140src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
Brian Paulc6184f82015-05-25 10:18:35 -0600[diff] [blame^]141
142</ul>
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]143
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]144
145<h2 id="submitting">Submitting patches</h2>
Timothy Arceri23820112013-09-05 02:54:00 -0600[diff] [blame]146
147<p>
Brian Pauld9598852015-05-25 09:42:04 -0600[diff] [blame]148The basic guidelines for submitting patches are:
149</p>
150
151<ul>
152<li>Patches should be sufficiently tested before submitting.
153<li>Code patches should follow Mesa coding conventions.
154<li>Whenever possible, patches should only effect individual Mesa/Gallium
155components.
156<li>Patches should never introduce build breaks and should be bisectable (see
157<code>git bisect</code>.)
158<li>Patches should be properly formatted (see below).
159<li>Patches should be submitted to mesa-dev for review using
160<code>git send-email</code>.
161<li>Patches should not mix code changes with code formatting changes (except,
162perhaps, in very trivial cases.)
163</ul>
164
165<h3>Patch formatting</h3>
166
167<p>
168The basic rules for patch formatting are:
169</p>
170
171<ul>
172<li>Lines should be limited to 75 characters or less so that git logs
173displayed in 80-column terminals avoid line wrapping. Note that git
174log uses 4 spaces of indentation (4 + 75 &lt; 80).
175<li>The first line should be a short, concise summary of the change prefixed
176with a module name. Examples:
177<pre>
178 mesa: Add support for querying GL_VERTEX_ATTRIB_ARRAY_LONG
179
180 gallium: add PIPE_CAP_DEVICE_RESET_STATUS_QUERY
181
182 i965: Fix missing type in local variable declaration.
183</pre>
184<li>Subsequent patch comments should describe the change in more detail,
185if needed. For example:
186<pre>
187 i965: Remove end-of-thread SEND alignment code.
188
189 This was present in Eric's initial implementation of the compaction code
190 for Sandybridge (commit 077d01b6). There is no documentation saying this
191 is necessary, and removing it causes no regressions in piglit on any
192 platform.
193</pre>
194<li>A "Signed-off-by:" line is not required, but not discouraged either.
195<li>If a patch address a bugzilla issue, that should be noted in the
196patch comment. For example:
197<pre>
198 Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=89689
199</pre>
200<li>If there have been several revisions to a patch during the review
201process, they should be noted such as in this example:
202<pre>
203 st/mesa: add ARB_texture_stencil8 support (v4)
204
205 if we support stencil texturing, enable texture_stencil8
206 there is no requirement to support native S8 for this,
207 the texture can be converted to x24s8 fine.
208
209 v2: fold fixes from Marek in:
210 a) put S8 last in the list
211 b) fix renderable to always test for d/s renderable
212 fixup the texture case to use a stencil only format
213 for picking the format for the texture view.
214 v3: hit fallback for getteximage
215 v4: put s8 back in front, it shouldn't get picked now (Ilia)
216</pre>
217<li>If someone tested your patch, document it with a line like this:
218<pre>
219 Tested-by: Joe Hacker &lt;jhacker@foo.com&gt;
220</pre>
221<li>If the patch was reviewed (usually the case) or acked by someone,
222that should be documented with:
223<pre>
224 Reviewed-by: Joe Hacker &lt;jhacker@foo.com&gt;
225 Acked-by: Joe Hacker &lt;jhacker@foo.com&gt;
226</pre>
227</ul>
228
229
230
231<h3>Testing Patches</h3>
232
233<p>
234It should go without saying that patches must be tested. In general,
235do whatever testing is prudent.
236</p>
237
238<p>
239You should always run the Mesa test suite before submitting patches.
240The test suite can be run using the 'make check' command. All tests
Timothy Arceri23820112013-09-05 02:54:00 -0600[diff] [blame]241must pass before patches will be accepted, this may mean you have
242to update the tests themselves.
243</p>
244
245<p>
Brian Pauld9598852015-05-25 09:42:04 -0600[diff] [blame]246Whenever possible and applicable, test the patch with
247<a href="http://people.freedesktop.org/~nh/piglit/">Piglit</a> to
248check for regressions.
249</p>
250
251
252<h3>Mailing Patches</h3>
253
254<p>
Timothy Arceri23820112013-09-05 02:54:00 -0600[diff] [blame]255Patches should be sent to the Mesa mailing list for review.
256When submitting a patch make sure to use git send-email rather than attaching
257patches to emails. Sending patches as attachments prevents people from being
258able to provide in-line review comments.
259</p>
260
261<p>
262When submitting follow-up patches you can use --in-reply-to to make v2, v3,
263etc patches show up as replies to the originals. This usually works well
264when you're sending out updates to individual patches (as opposed to
265re-sending the whole series). Using --in-reply-to makes
266it harder for reviewers to accidentally review old patches.
267</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]268
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]269<h3>Marking a commit as a candidate for a stable branch</h3>
Andreas Bollf07784d2012-10-02 13:37:34 +0200[diff] [blame]270
271<p>
272If you want a commit to be applied to a stable branch,
273you should add an appropriate note to the commit message.
274</p>
275
276<p>
277Here are some examples of such a note:
278</p>
279<ul>
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]280 <li>CC: &lt;mesa-stable@lists.freedesktop.org&gt;</li>
281 <li>CC: "9.2 10.0" &lt;mesa-stable@lists.freedesktop.org&gt;</li>
282 <li>CC: "10.0" &lt;mesa-stable@lists.freedesktop.org&gt;</li>
Andreas Bollf07784d2012-10-02 13:37:34 +0200[diff] [blame]283</ul>
284
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]285Simply adding the CC to the mesa-stable list address is adequate to nominate
286the commit for the most-recently-created stable branch. It is only necessary
287to specify a specific branch name, (such as "9.2 10.0" or "10.0" in the
288examples above), if you want to nominate the commit for an older stable
289branch. And, as in these examples, you can nominate the commit for the older
290branch in addition to the more recent branch, or nominate the commit
291exclusively for the older branch.
292
293This "CC" syntax for patch nomination will cause patches to automatically be
294copied to the mesa-stable@ mailing list when you use "git send-email" to send
295patches to the mesa-dev@ mailing list. Also, if you realize that a commit
Nathan Kidd0691b372014-01-03 16:44:00 -0700[diff] [blame]296should be nominated for the stable branch after it has already been committed,
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]297you can send a note directly to the mesa-stable@lists.freedesktop.org where
298the Mesa stable-branch maintainers will receive it. Be sure to mention the
299commit ID of the commit of interest (as it appears in the mesa master branch).
Andreas Boll1f38fb22012-10-02 13:55:53 +0200[diff] [blame]300
Carl Worth4546b702014-04-30 16:27:03 -0700[diff] [blame]301The latest set of patches that have been nominated, accepted, or rejected for
302the upcoming stable release can always be seen on the
Carl Worth399b4e22014-08-21 09:46:57 -0700[diff] [blame]303<a href="http://cworth.org/~cworth/mesa-stable-queue/">Mesa Stable Queue</a>
Carl Worth4546b702014-04-30 16:27:03 -0700[diff] [blame]304page.
305
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]306<h3>Criteria for accepting patches to the stable branch</h3>
Andreas Boll1f38fb22012-10-02 13:55:53 +0200[diff] [blame]307
Carl Worth399b4e22014-08-21 09:46:57 -0700[diff] [blame]308Mesa has a designated release manager for each stable branch, and the release
309manager is the only developer that should be pushing changes to these
310branches. Everyone else should simply nominate patches using the mechanism
311described above.
312
313The stable-release manager will work with the list of nominated patches, and
314for each patch that meets the crtieria below will cherry-pick the patch with:
315<code>git cherry-pick -x &lt;commit&gt;</code>. The <code>-x</code> option is
316important so that the picked patch references the comit ID of the original
317patch.
318
319The stable-release manager may at times need to force-push changes to the
320stable branches, for example, to drop a previously-picked patch that was later
321identified as causing a regression). These force-pushes may cause changes to
322be lost from the stable branch if developers push things directly. Consider
323yourself warned.
324
325The stable-release manager is also given broad discretion in rejecting patches
326that have been nominated for the stable branch. The most basic rule is that
327the stable branch is for bug fixes only, (no new features, no
328regressions). Here is a non-exhaustive list of some reasons that a patch may
329be rejected:
330
331<ul>
332 <li>Patch introduces a regression. Any reported build breakage or other
333 regression caused by a particular patch, (game no longer work, piglit test
334 changes from PASS to FAIL), is justification for rejecting a patch.</li>
335
336 <li>Patch is too large, (say, larger than 100 lines)</li>
337
338 <li>Patch is not a fix. For example, a commit that moves code around with no
339 functional change should be rejected.</li>
340
341 <li>Patch fix is not clearly described. For example, a commit message
342 of only a single line, no description of the bug, no mention of bugzilla,
343 etc.</li>
344
345 <li>Patch has not obviously been reviewed, For example, the commit message
346 has no Reviewed-by, Signed-off-by, nor Tested-by tags from anyone but the
347 author.</li>
348
349 <li>Patch has not already been merged to the master branch. As a rule, bug
350 fixes should never be applied first to a stable branch. Patches should land
351 first on the master branch and then be cherry-picked to a stable
352 branch. (This is to avoid future releases causing regressions if the patch
353 is not also applied to master.) The only things that might look like
354 exceptions would be backports of patches from master that happen to look
355 significantly different.</li>
356
357 <li>Patch depends on too many other patches. Ideally, all stable-branch
358 patches should be self-contained. It sometimes occurs that a single, logical
359 bug-fix occurs as two separate patches on master, (such as an original
360 patch, then a subsequent fix-up to that patch). In such a case, these two
361 patches should be squashed into a single, self-contained patch for the
362 stable branch. (Of course, if the squashing makes the patch too large, then
363 that could be a reason to reject the patch.)</li>
364
365 <li>Patch includes new feature development, not bug fixes. New OpenGL
366 features, extensions, etc. should be applied to Mesa master and included in
367 the next major release. Stable releases are intended only for bug fixes.
368
369 Note: As an exception to this rule, the stable-release manager may accept
370 hardware-enabling "features". For example, backports of new code to support
371 a newly-developed hardware product can be accepted if they can be reasonably
372 determined to not have effects on other hardware.</li>
373
374 <li>Patch is a performance optimization. As a rule, performance patches are
375 not candidates for the stable branch. The only exception might be a case
376 where an application's performance was recently severely impacted so as to
377 become unusable. The fix for this performance regression could then be
378 considered for a stable branch. The optimization must also be
379 non-controversial and the patches still need to meet the other criteria of
380 being simple and self-contained</li>
381
382 <li>Patch introduces a new failure mode (such as an assert). While the new
383 assert might technically be correct, for example to make Mesa more
384 conformant, this is not the kind of "bug fix" we want in a stable
385 release. The potential problem here is that an OpenGL program that was
386 previously working, (even if technically non-compliant with the
387 specification), could stop working after this patch. So that would be a
388 regression that is unaacceptable for the stable branch.</li>
389</ul>
Andreas Boll1f38fb22012-10-02 13:55:53 +0200[diff] [blame]390
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]391
392<h2 id="release">Making a New Mesa Release</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]393
394<p>
395These are the instructions for making a new Mesa release.
396</p>
397
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]398<h3>Get latest source files</h3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]399<p>
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]400Use git to get the latest Mesa files from the git repository, from whatever
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]401branch is relevant. This document uses the convention X.Y.Z for the release
402being created, which should be created from a branch named X.Y.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]403</p>
404
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]405<h3>Perform basic testing</h3>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]406<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]407The release manager should, at the very least, test the code by compiling it,
408installing it, and running the latest piglit to ensure that no piglit tests
409have regressed since the previous release.
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]410</p>
411
412<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]413The release manager should do this testing with at least one hardware driver,
414(say, whatever is contained in the local development machine), as well as on
415both Gallium and non-Gallium software drivers. The software testing can be
416performed by running piglit with the following environment-variable set:
Andreas Bollb347bb52012-06-25 21:53:06 +0200[diff] [blame]417</p>
418
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]419<pre>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]420LIBGL_ALWAYS_SOFTWARE=1
421</pre>
422
423And Gallium vs. non-Gallium software drivers can be obtained by using the
424following configure flags on separate builds:
425
426<pre>
427--with-dri-drivers=swrast
428--with-gallium-drivers=swrast
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]429</pre>
430
431<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]432Note: If both options are given in one build, both swrast_dri.so drivers will
433be compiled, but only one will be installed. The following command can be used
434to ensure the correct driver is being tested:
435</p>
436
437<pre>
438LIBGL_ALWAYS_SOFTWARE=1 glxinfo | grep "renderer string"
439</pre>
440
441If any regressions are found in this testing with piglit, stop here, and do
442not perform a release until regressions are fixed.
443
444<h3>Update version in file VERSION</h3>
445
446<p>
447Increment the version contained in the file VERSION at Mesa's top-level, then
448commit this change.
449</p>
450
451<h3>Create release notes for the new release</h3>
452
453<p>
454Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
455release notes). Note that the sha256sums section of the release notes should
456be empty at this point.
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]457</p>
458
459<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]460Two scripts are available to help generate portions of the release notes:
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]461
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]462<pre>
463 ./bin/bugzilla_mesa.sh
464 ./bin/shortlog_mesa.sh
465</pre>
466
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]467<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]468The first script identifies commits that reference bugzilla bugs and obtains
469the descriptions of those bugs from bugzilla. The second script generates a
470log of all commits. In both cases, HTML-formatted lists are printed to stdout
471to be included in the release notes.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]472</p>
473
474<p>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]475Commit these changes
476</p>
477
478<h3>Make the release archives, signatures, and the release tag</h3>
479<p>
480From inside the Mesa directory:
481<pre>
482 ./autogen.sh
483 make -j1 tarballs
484</pre>
485
486<p>
487After the tarballs are created, the sha256 checksums for the files will
488be computed and printed. These will be used in a step below.
489</p>
490
491<p>
492It's important at this point to also verify that the constructed tar file
493actually builds:
494</p>
495
496<pre>
497 tar xjf MesaLib-X.Y.Z.tar.bz2
498 cd Mesa-X.Y.Z
499 ./configure --enable-gallium-llvm
500 make -j6
501 make install
502</pre>
503
504<p>
505Some touch testing should also be performed at this point, (run glxgears or
506more involved OpenGL programs against the installed Mesa).
507</p>
508
509<p>
510Create detached GPG signatures for each of the archive files created above:
511</p>
512
513<pre>
514 gpg --sign --detach MesaLib-X.Y.Z.tar.gz
515 gpg --sign --detach MesaLib-X.Y.Z.tar.bz2
516 gpg --sign --detach MesaLib-X.Y.Z.zip
517</pre>
518
519<p>
520Tag the commit used for the build:
521</p>
522
523<pre>
524 git tag -s mesa-X.Y.X -m "Mesa X.Y.Z release"
525</pre>
526
527<p>
528Note: It would be nice to investigate and fix the issue that causes the
529tarballs target to fail with multiple build process, such as with "-j4". It
530would also be nice to incorporate all of the above commands into a single
531makefile target. And instead of a custom "tarballs" target, we should
532incorporate things into the standard "make dist" and "make distcheck" targets.
533</p>
534
535<h3>Add the sha256sums to the release notes</h3>
536
537<p>
538Edit docs/relnotes/X.Y.Z.html to add the sha256sums printed as part of "make
539tarballs" in the previous step. Commit this change.
540</p>
541
542<h3>Push all commits and the tag creates above</h3>
543
544<p>
545This is the first step that cannot easily be undone. The release is going
546forward from this point:
547</p>
548
549<pre>
550 git push origin X.Y --tags
551</pre>
552
553<h3>Install the release files and signatures on the distribution server</h3>
554
555<p>
556The following commands can be used to copy the release archive files and
557signatures to the freedesktop.org server:
558</p>
559
560<pre>
561 scp MesaLib-X.Y.Z* people.freedesktop.org:
562 ssh people.freedesktop.org
563 cd /srv/ftp.freedesktop.org/pub/mesa
564 mkdir X.Y.Z
565 cd X.Y.Z
566 mv ~/MesaLib-X.Y.Z* .
567</pre>
568
569<h3>Back on mesa master, andd the new release notes into the tree</h3>
570
571<p>
572Something like the following steps will do the trick:
573</p>
574
575<pre>
576 cp docs/relnotes/X.Y.Z.html /tmp
577 git checkout master
578 cp /tmp/X.Y.Z.html docs/relnotes
579 git add docs/relnotes/X.Y.Z.html
580</pre>
581
582<p>
583Also, edit docs/relnotes.html to add a link to the new release notes, and edit
584docs/index.html to add a news entry. Then commit and push:
585</p>
586
587<pre>
588 git commit -a -m "docs: Import X.Y.Z release notes, add news item."
589 git push origin
590</pre>
591
592<h3>Update the mesa3d.org website</h3>
593
594<p>
595NOTE: The recent release managers have not been performing this step
596themselves, but leaving this to Brian Paul, (who has access to the
597sourceforge.net hosting for mesa3d.org). Brian is more than willing to grant
598the permission necessary to future release managers to do this step on their
599own.
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]600</p>
601
602<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]603Update the web site by copying the docs/ directory's files to
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]604/home/users/b/br/brianp/mesa-www/htdocs/ with:
605<br>
606<code>
607sftp USERNAME,mesa3d@web.sourceforge.net
608</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]609</p>
610
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]611
612<h3>Announce the release</h3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]613<p>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]614Make an announcement on the mailing lists:
Ian Romanick8f32c642010-06-16 14:28:08 -0700[diff] [blame]615
Kenneth Graunke7d24d1b2013-07-25 11:42:38 -0700[diff] [blame]616<em>mesa-dev@lists.freedesktop.org</em>,
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]617and
Kenneth Graunke7d24d1b2013-07-25 11:42:38 -0700[diff] [blame]618<em>mesa-announce@lists.freedesktop.org</em>
Carl Worth619505a2014-08-21 10:44:35 -0700[diff] [blame]619
620Follow the template of previously-sent release announcements. The following
621command can be used to generate the log of changes to be included in the
622release announcement:
623
624<pre>
625 git shortlog mesa-X.Y.Z-1..mesa-X.Y.Z
626</pre>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]627</p>
628
Brian Paul98f2f472015-05-25 09:13:09 -0600[diff] [blame]629
630<h2 id="extensions">Adding Extensions</h2>
631
632<p>
633To add a new GL extension to Mesa you have to do at least the following.
634
635<ul>
636<li>
637 If glext.h doesn't define the extension, edit include/GL/gl.h and add
638 code like this:
639 <pre>
640 #ifndef GL_EXT_the_extension_name
641 #define GL_EXT_the_extension_name 1
642 /* declare the new enum tokens */
643 /* prototype the new functions */
644 /* TYPEDEFS for the new functions */
645 #endif
646 </pre>
647</li>
648<li>
649 In the src/mapi/glapi/gen/ directory, add the new extension functions and
650 enums to the gl_API.xml file.
651 Then, a bunch of source files must be regenerated by executing the
652 corresponding Python scripts.
653</li>
654<li>
655 Add a new entry to the <code>gl_extensions</code> struct in mtypes.h
656</li>
657<li>
658 Update the <code>extensions.c</code> file.
659</li>
660<li>
661 From this point, the best way to proceed is to find another extension,
662 similar to the new one, that's already implemented in Mesa and use it
663 as an example.
664</li>
665<li>
666 If the new extension adds new GL state, the functions in get.c, enable.c
667 and attrib.c will most likely require new code.
668</li>
669<li>
670 The dispatch tests check_table.cpp and dispatch_sanity.cpp
671 should be updated with details about the new extensions functions. These
672 tests are run using 'make check'
673</li>
674</ul>
675
676
677
678
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]679</div>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]680</body>
681</html>