Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / 9cef3efc299b7cafb5720782fc1ed5731f47d7ce / . / docs / devinfo.html
blob: e1761be22340ebcea62deb3ef2e2268a7399133c [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>
42 If hew extension adds new GL state, the functions in get.c, enable.c
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>
97Global vars not allowed.
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
112<H2>Writing a Device Driver</H2>
113
114<p>
115XXX to do
116</p>
117
118
119
120<H2>Making a New Mesa Release</H2>
121
122<p>
123These are the instructions for making a new Mesa release.
124</p>
125
126<p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]127Be sure to do a "cvs update -d ." in the Mesa directory to
128get all the latest files.
129</p>
130
131<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]132Update the version definitions in src/mesa/main/version.h
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]133</p>
134
135<p>
Brian Paul68155872003-06-01 16:28:00 +0000[diff] [blame]136Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]137Update the docs/VERSIONS file too.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]138</p>
139
140<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]141Edit configs/default and change the MESA_MAJOR, MESA_MINOR and MESA_TINY
142version numbers.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]143</p>
144
145<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]146Edit the top-level Makefile and verify that DIRECTORY, LIB_NAME and
147DEMO_NAME are correct.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]148</p>
149
150<p>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]151Make a symbolic link from $(DIRECTORY) to 'Mesa'. For example,
152ln -s Mesa Mesa-6.3 This is needed in order to make a correct
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]153tar file in the next step.
154</p>
155
156<p>
157Make the distribution files. From inside the Mesa directory:
158<pre>
Brian Paul9cef3ef2004-10-02 15:43:14 +0000[diff] [blame^]159 make tarballs
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]160</pre>
161
162<p>
163Copy the distribution files to a temporary directory, unpack them,
164compile everything, and run some demos to be sure everything works.
165</p>
166
167<p>
168Upload the *.tar.gz and *.zip files to ftp.mesa3d.org
169</p>
170
171<p>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]172Update the web site.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]173</p>
174
175<p>
Brian Paulefe56712003-03-19 19:15:28 +0000[diff] [blame]176Make an announcement on the mailing lists:
177<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>,
178<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>
179and
180<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]181</p>
182
183
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]184
185</body>
186</html>