Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / 65b79057b96e621de1bbd7b9c81cdbcee6bfa5b1 / . / docs / devinfo.html
blob: 498b713e5c2ef87558b43ee766f66cc90009518a [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]1<HTML>
2
3<TITLE>Development Notes</TITLE>
4
5<BODY text="#000000" bgcolor="#55bbff" link="#111188">
6
7<H1>Development Notes</H1>
8
9
10<H2>Adding Extentions</H2>
11
12<p>
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]13To 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]14
Brian Paul51830612004-08-17 14:08:59 +0000[diff] [blame]15<ul>
16<li>
17 If glext.h doesn't define the extension, edit include/GL/gl.h and add
18 code like this:
19 <pre>
20 #ifndef GL_EXT_the_extension_name
21 #define GL_EXT_the_extension_name 1
22 /* declare the new enum tokens */
23 /* prototype the new functions */
24 /* TYPEDEFS for the new functions */
25 #endif
26 </pre>
27</li>
28<li>
29 In the src/mesa/glapi/ directory, add the new extension functions and
30 enums to the gl_API.xml file.
31 Then, a bunch of source files must be regenerated by executing the
32 corresponding Python scripts.
33</li>
34<li>
35 Find an existing extension that's similar to the new one and search
36 the sources for code related to that extension.
37 Implement new code as needed.
38 In general, new state variables will be added to mtypes.h. If the
39 extension is rather large, try to implement it in a new source file.
40</li>
41<li>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]42 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]43 and attrib.c will most likely require new code.
44</li>
45</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]46
47
48
49<H2>Coding Style</H2>
50
51<p>
52Mesa's code style has changed over the years. Here's the latest.
53</p>
54
55<p>
56Comment your code! It's extremely important that open-source code be
57well documented. Also, strive to write clean, easily understandable code.
58</p>
59
60<p>
613-space indentation
62</p>
63
64<p>
65If you use tabs, set them to 8 columns
66</p>
67
68<p>
69Brace example:
70</p>
71<pre>
72 if (condition) {
73 foo;
74 }
75 else {
76 bar;
77 }
78</pre>
79
80<p>
81Here's the GNU indent command which will best approximate my preferred style:
82</p>
83<pre>
84 indent -br -i3 -npcs infile.c -o outfile.c
85</pre>
86
87
88<p>
89Local variable name example: localVarName (no underscores)
90</p>
91
92<p>
93Constants and macros are ALL_UPPERCASE, with _ between words
94</p>
95
96<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]97Global variables are not allowed.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]98</p>
99
100<p>
101Function name examples:
102</p>
103<pre>
104 glFooBar() - a public GL entry point (in dispatch.c)
105 _mesa_FooBar() - the internal immediate mode function
106 save_FooBar() - retained mode (display list) function in dlist.c
107 foo_bar() - a static (private) function
108 _mesa_foo_bar() - an internal non-static Mesa function
109</pre>
110
111
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]112<H2>Making a New Mesa Release</H2>
113
114<p>
115These are the instructions for making a new Mesa release.
116</p>
117
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]118<H3>Get latest source files</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]119<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]120Use "cvs update -dAP " to get the latest Mesa files from CVS.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]121</p>
122
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]123
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]124<H3>Verify and update version info</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]125<p>
Brian Paul68155872003-06-01 16:28:00 +0000[diff] [blame]126Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]127Add the new RELNOTES-X.Y file to <a href="relnotes.html">relnotes.html</a>.
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]128Update the docs/VERSIONS file too.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]129</p>
130
131<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]132Edit configs/default and change the MESA_MAJOR, MESA_MINOR and MESA_TINY
133version numbers.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]134</p>
135
136<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]137Make sure the values in src/mesa/main/version.h is correct.
138</p>
139
140<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]141Edit the top-level Makefile and verify that DIRECTORY, LIB_NAME and
142DEMO_NAME are correct.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]143</p>
144
145<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]146Update the docs/news.html file and docs/contents.html files.
147</p>
148
149<p>
150Check in all updates to CVS.
151</p>
152
153<p>
154Tag the CVS files with the release name (in the form <b>mesa_X_Y</b>).
155</p>
156
157
158<H3>Make the tarballs</H3>
159<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]160Make a symbolic link from $(DIRECTORY) to 'Mesa'. For example,
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]161ln -s Mesa Mesa-6.3
162This is needed in order to make a correct tar file in the next step.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]163</p>
164
165<p>
166Make the distribution files. From inside the Mesa directory:
167<pre>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame]168 make tarballs
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]169</pre>
170
171<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]172After the tarballs are created, the md5 checksums for the files will
173be computed.
174Add them to the docs/news.html file.
175</p>
176
177<p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]178Copy the distribution files to a temporary directory, unpack them,
179compile everything, and run some demos to be sure everything works.
180</p>
181
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]182<H3>Update the website and announce the release</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]183<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]184Follow the directions on SourceForge for creating a new "release" and
185uploading the tarballs.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]186</p>
187
188<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame^]189Update the web site by copying the docs/ directory's files to
190/home/users/b/br/brianp/mesa-www/htdocs/
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]191</p>
192
193<p>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]194Make an announcement on the mailing lists:
195<em>m</em><em>e</em><em>s</em><em>a</em><em>3</em><em>d</em><em>-</em><em>d</em><em>e</em><em>v</em><em>@</em><em>l</em><em>i</em><em>s</em><em>t</em><em>s</em><em>.</em><em>s</em><em>f</em><em>.</em><em>n</em><em>e</em><em>t</em>,
196<em>m</em><em>e</em><em>s</em><em>a</em><em>3</em><em>d</em><em>-</em><em>u</em><em>s</em><em>e</em><em>r</em><em>s</em><em>@</em><em>l</em><em>i</em><em>s</em><em>t</em><em>s</em><em>.</em><em>s</em><em>f</em><em>.</em><em>n</em><em>e</em><em>t</em>
197and
198<em>m</em><em>e</em><em>s</em><em>a</em><em>3</em><em>d</em><em>-</em><em>a</em><em>n</em><em>n</em><em>o</em><em>u</em><em>n</em><em>c</em><em>e</em><em>@</em><em>l</em><em>i</em><em>s</em><em>t</em><em>s</em><em>.</em><em>s</em><em>f</em><em>.</em><em>n</em><em>e</em><em>t</em>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]199</p>
200
201
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]202
203</body>
204</html>