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