Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / ffa39ab067ae360ceffdf8f1eb6d84f0ebdf6c94 / . / docs / devinfo.html
blob: 67c1f34bdae53967484a85b113280b599de8fb2f [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
Carl Worth16c29192013-12-12 23:02:54 -0800[diff] [blame]20<h2>Adding Extensions</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]21
22<p>
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]23To add a new GL extension to Mesa you have to do at least the following.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]24
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]25<ul>
26<li>
27 If glext.h doesn't define the extension, edit include/GL/gl.h and add
28 code like this:
29 <pre>
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 */
35 #endif
36 </pre>
37</li>
38<li>
Timothy Arceri37f9e0e2013-08-02 21:57:50 +1000[diff] [blame]39 In the src/mapi/glapi/gen/ directory, add the new extension functions and
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]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.
43</li>
44<li>
Brian Paulbb086292006-09-21 22:53:15 +0000[diff] [blame]45 Add a new entry to the <code>gl_extensions</code> struct in mtypes.h
46</li>
47<li>
48 Update the <code>extensions.c</code> file.
49</li>
50<li>
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
53 as an example.
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]54</li>
55<li>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]56 If the new extension adds new GL state, the functions in get.c, enable.c
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]57 and attrib.c will most likely require new code.
58</li>
Timothy Arceriffa39ab2014-04-02 17:35:17 +1100[diff] [blame^]59<li>
60 The dispatch tests check_table.cpp and dispatch_sanity.cpp
61 should be updated with details about the new extensions functions. These
62 tests are run using 'make check'
63</li>
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]64</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]65
66
67
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]68<h2>Coding Style</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]69
70<p>
71Mesa's code style has changed over the years. Here's the latest.
72</p>
73
74<p>
75Comment your code! It's extremely important that open-source code be
76well documented. Also, strive to write clean, easily understandable code.
77</p>
78
79<p>
803-space indentation
81</p>
82
83<p>
84If you use tabs, set them to 8 columns
85</p>
86
87<p>
Paul Berry43968262011-08-16 14:09:32 -0700[diff] [blame]88Line width: the preferred width to fill comments and code in Mesa is 78
89columns. Exceptions are sometimes made for clarity (e.g. tabular data is
90sometimes filled to a much larger width so that extraneous carriage returns
91don't obscure the table).
92</p>
93
94<p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]95Brace example:
96</p>
97<pre>
98 if (condition) {
99 foo;
100 }
101 else {
102 bar;
103 }
Paul Berry43968262011-08-16 14:09:32 -0700[diff] [blame]104
105 switch (condition) {
106 case 0:
107 foo();
108 break;
109
110 case 1: {
111 ...
112 break;
113 }
114
115 default:
116 ...
117 break;
118 }
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]119</pre>
120
121<p>
122Here's the GNU indent command which will best approximate my preferred style:
Paul Berry43968262011-08-16 14:09:32 -0700[diff] [blame]123(Note that it won't format switch statements in the preferred way)
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]124</p>
125<pre>
Brian Paule3f41ce2006-03-31 23:10:21 +0000[diff] [blame]126 indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]127</pre>
128
129
130<p>
131Local variable name example: localVarName (no underscores)
132</p>
133
134<p>
135Constants and macros are ALL_UPPERCASE, with _ between words
136</p>
137
138<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]139Global variables are not allowed.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]140</p>
141
142<p>
143Function name examples:
144</p>
145<pre>
Chia-I Wu27d260b42010-02-24 11:20:14 +0800[diff] [blame]146 glFooBar() - a public GL entry point (in glapi_dispatch.c)
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]147 _mesa_FooBar() - the internal immediate mode function
148 save_FooBar() - retained mode (display list) function in dlist.c
149 foo_bar() - a static (private) function
150 _mesa_foo_bar() - an internal non-static Mesa function
151</pre>
152
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]153<p>
154Places that are not directly visible to the GL API should prefer the use
155of <tt>bool</tt>, <tt>true</tt>, and
156<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and
157<tt>GL_FALSE</tt>. In C code, this may mean that
Kai Wasserbäche106d4c2011-08-27 17:51:47 +0200[diff] [blame]158<tt>#include &lt;stdbool.h&gt;</tt> needs to be added. The
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]159<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]160src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
Kai Wasserbächdbec3a52011-08-23 10:48:58 +0200[diff] [blame]161</p>
162
Timothy Arceri23820112013-09-05 02:54:00 -0600[diff] [blame]163<h2>Submitting patches</h2>
164
165<p>
166You should always run the Mesa Testsuite before submitting patches.
167The Testsuite can be run using the 'make check' command. All tests
168must pass before patches will be accepted, this may mean you have
169to update the tests themselves.
170</p>
171
172<p>
173Patches should be sent to the Mesa mailing list for review.
174When submitting a patch make sure to use git send-email rather than attaching
175patches to emails. Sending patches as attachments prevents people from being
176able to provide in-line review comments.
177</p>
178
179<p>
180When submitting follow-up patches you can use --in-reply-to to make v2, v3,
181etc patches show up as replies to the originals. This usually works well
182when you're sending out updates to individual patches (as opposed to
183re-sending the whole series). Using --in-reply-to makes
184it harder for reviewers to accidentally review old patches.
185</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]186
Andreas Bollf07784d2012-10-02 13:37:34 +0200[diff] [blame]187<h2>Marking a commit as a candidate for a stable branch</h2>
188
189<p>
190If you want a commit to be applied to a stable branch,
191you should add an appropriate note to the commit message.
192</p>
193
194<p>
195Here are some examples of such a note:
196</p>
197<ul>
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]198 <li>CC: &lt;mesa-stable@lists.freedesktop.org&gt;</li>
199 <li>CC: "9.2 10.0" &lt;mesa-stable@lists.freedesktop.org&gt;</li>
200 <li>CC: "10.0" &lt;mesa-stable@lists.freedesktop.org&gt;</li>
Andreas Bollf07784d2012-10-02 13:37:34 +0200[diff] [blame]201</ul>
202
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]203Simply adding the CC to the mesa-stable list address is adequate to nominate
204the commit for the most-recently-created stable branch. It is only necessary
205to specify a specific branch name, (such as "9.2 10.0" or "10.0" in the
206examples above), if you want to nominate the commit for an older stable
207branch. And, as in these examples, you can nominate the commit for the older
208branch in addition to the more recent branch, or nominate the commit
209exclusively for the older branch.
210
211This "CC" syntax for patch nomination will cause patches to automatically be
212copied to the mesa-stable@ mailing list when you use "git send-email" to send
213patches to the mesa-dev@ mailing list. Also, if you realize that a commit
Nathan Kidd0691b372014-01-03 16:44:00 -0700[diff] [blame]214should be nominated for the stable branch after it has already been committed,
Carl Worthd6c83652013-12-12 23:07:26 -0800[diff] [blame]215you can send a note directly to the mesa-stable@lists.freedesktop.org where
216the Mesa stable-branch maintainers will receive it. Be sure to mention the
217commit ID of the commit of interest (as it appears in the mesa master branch).
Andreas Boll1f38fb22012-10-02 13:55:53 +0200[diff] [blame]218
219<h2>Cherry-picking candidates for a stable branch</h2>
220
221<p>
222Please use <code>git cherry-pick -x &lt;commit&gt;</code> for cherry-picking a commit
223from master to a stable branch.
224</p>
225
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]226<h2>Making a New Mesa Release</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]227
228<p>
229These are the instructions for making a new Mesa release.
230</p>
231
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]232<h3>Get latest source files</h3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]233<p>
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]234Use git to get the latest Mesa files from the git repository, from whatever
235branch is relevant.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]236</p>
237
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]238
Emil Velikov488b3ed2013-07-25 23:45:45 +0100[diff] [blame]239<h3>Verify and update version info in VERSION</h3>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]240
241<p>
Emil Velikov5fd3b3b2013-04-12 12:41:49 +0100[diff] [blame]242Create a docs/relnotes/x.y.z.html file.
Andreas Bolldf012012013-04-17 18:45:15 +0200[diff] [blame]243The bin/bugzilla_mesa.sh and bin/shortlog_mesa.sh scripts can be used to
244create the HTML-formatted lists of bugfixes and changes to include in the file.
Emil Velikov5fd3b3b2013-04-12 12:41:49 +0100[diff] [blame]245Link the new docs/relnotes/x.y.z.html file into the main <a href="relnotes.html">relnotes.html</a> file.
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]246</p>
247
248<p>
Andreas Boll7b092542012-09-18 18:59:33 +0200[diff] [blame]249Update <a href="index.html">docs/index.html</a>.
Andreas Bollb347bb52012-06-25 21:53:06 +0200[diff] [blame]250</p>
251
252<p>
253Tag the files with the release name (in the form <b>mesa-x.y</b>)
Andreas Bolld59bd612013-01-30 22:35:58 +0100[diff] [blame]254with: <code>git tag -s mesa-x.y -m "Mesa x.y Release"</code>
Andreas Bollb347bb52012-06-25 21:53:06 +0200[diff] [blame]255Then: <code>git push origin mesa-x.y</code>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]256</p>
257
258
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]259<h3>Make the tarballs</h3>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]260<p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]261Make the distribution files. From inside the Mesa directory:
262<pre>
Andreas Bolld59bd612013-01-30 22:35:58 +0100[diff] [blame]263 ./autogen.sh
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]264 make tarballs
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]265</pre>
266
267<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]268After the tarballs are created, the md5 checksums for the files will
269be computed.
Emil Velikov5fd3b3b2013-04-12 12:41:49 +0100[diff] [blame]270Add them to the docs/relnotes/x.y.html file.
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]271</p>
272
273<p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]274Copy the distribution files to a temporary directory, unpack them,
275compile everything, and run some demos to be sure everything works.
276</p>
277
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]278<h3>Update the website and announce the release</h3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]279<p>
Andreas Bolld59bd612013-01-30 22:35:58 +0100[diff] [blame]280Make a new directory for the release on annarchy.freedesktop.org with:
281<br>
282<code>
283mkdir /srv/ftp.freedesktop.org/pub/mesa/x.y
284</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]285</p>
286
287<p>
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]288Basically, to upload the tarball files with:
289<br>
290<code>
Andreas Bolld59bd612013-01-30 22:35:58 +0100[diff] [blame]291rsync -avP -e ssh MesaLib-x.y.* USERNAME@annarchy.freedesktop.org:/srv/ftp.freedesktop.org/pub/mesa/x.y/
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]292</code>
293</p>
294
295<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]296Update the web site by copying the docs/ directory's files to
Brian Paul84c5e482009-06-23 19:21:04 -0600[diff] [blame]297/home/users/b/br/brianp/mesa-www/htdocs/ with:
298<br>
299<code>
300sftp USERNAME,mesa3d@web.sourceforge.net
301</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]302</p>
303
304<p>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]305Make an announcement on the mailing lists:
Ian Romanick8f32c642010-06-16 14:28:08 -0700[diff] [blame]306
Kenneth Graunke7d24d1b2013-07-25 11:42:38 -0700[diff] [blame]307<em>mesa-dev@lists.freedesktop.org</em>,
308<em>mesa-users@lists.freedesktop.org</em>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]309and
Kenneth Graunke7d24d1b2013-07-25 11:42:38 -0700[diff] [blame]310<em>mesa-announce@lists.freedesktop.org</em>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]311</p>
312
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]313</div>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]314</body>
315</html>