summaryrefslogtreecommitdiffstats
path: root/docs/devinfo.html
blob: 398637c51c5ad1c574eff9920f05bf78615935ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<HTML>

<TITLE>Development Notes</TITLE>

<BODY text="#000000" bgcolor="#55bbff" link="#111188">

<H1>Development Notes</H1>


<H2>Adding Extentions</H2>

<p>
To add a new GL extension to Mesa you have to do the following.
<pre>
   If glext.h doesn't define the extension, edit include/GL/gl.h and add:
	- new enum tokens
	- new API function entry points
	- #define GL_EXT_the_extension_name 1

   If adding a new API function (call it glNewFunctionEXT):
	- insert glNewFunctionEXT()into src/apiext.h
	- edit src/types.h and add NewFunction to the gl_api_table struct
	- implement gl_NewFunction() in the appropriate src file
	- hook gl_NewFunction() into pointers.c
	- add display list support in dlist.c for save_NewFunction()
	- add glNewFunctionEXT to gl_GetProcAddress() in extensions.c or
	  in the device driver's GetProcAddress() function if appropriate
</pre>
<p>
If adding new GL state be sure to update get.c and enable.c
</p>
<p>
In general, look for an extension similar to the new one that's already
implemented in Mesa and follow it by example.
</p>



<H2>Coding Style</H2>

<p>
Mesa's code style has changed over the years.  Here's the latest.
</p>

<p>
Comment your code!  It's extremely important that open-source code be
well documented.  Also, strive to write clean, easily understandable code.
</p>

<p>
3-space indentation
</p>

<p>
If you use tabs, set them to 8 columns
</p>

<p>
Brace example:
</p>
<pre>
	if (condition) {
	   foo;
	}
	else {
	   bar;
	}
</pre>

<p>
Here's the GNU indent command which will best approximate my preferred style:
</p>
<pre>
	indent -br -i3 -npcs infile.c -o outfile.c
</pre>


<p>
Local variable name example:  localVarName (no underscores)
</p>

<p>
Constants and macros are ALL_UPPERCASE, with _ between words
</p>

<p>
Global vars not allowed.
</p>

<p>
Function name examples:
</p>
<pre>
	glFooBar()       - a public GL entry point (in dispatch.c)
	_mesa_FooBar()   - the internal immediate mode function
	save_FooBar()    - retained mode (display list) function in dlist.c
	foo_bar()        - a static (private) function
	_mesa_foo_bar()  - an internal non-static Mesa function
</pre>


<H2>Writing a Device Driver</H2>

<p>
XXX to do
</p>



<H2>Making a New Mesa Release</H2>

<p>
These are the instructions for making a new Mesa release.
</p>

<p>
Prerequisites (later versions may work):
</p>
<ul>
<li>	autoconf 2.50
<li>	automake 1.4-p2
<li>	libtool 1.4
</ul>

<p>
Be sure to do a "cvs update -d ." in the Mesa directory to
get all the latest files.
</p>

<p>
Update the version strings in src/get.c and src/X/fakeglx.c to return
the new Mesa version number.
</p>

<p>
Create/edit the docs/RELNOTES-X-Y file to document what's new in the release.
Edit the docs/VERSIONS file too.
</p>

<p>
Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions.
</p>

<p>
Edit the GNU configure stuff to change versions numbers as needed:
Update the version string (second argument) in the line
"AM_INIT_AUTOMAKE(Mesa, 3.3)" in the configure.in file.
</p>

<p>
Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
</p>

<p>
Verify the version numbers near the top of configure.in
</p>

<p>
Run "fixam -f" to disable automatic dependency tracking.
</p>

<p>
Run the bootstrap script to generate the configure script.
</p>

<p>
Edit Makefile.X11 and verify DIRECTORY is set correctly.  The Mesa
sources must be in that directory (or there must be a symbolic link).
</p>

<p>
Edit Makefile.X11 and verify that LIB_NAME and DEMO_NAME are correct.
If it's a beta release, be sure the bump up the beta release number.
</p>

<p>
cp Makefile.X11 to Makefile so that the old-style Mesa makefiles
still work.  ./configure will overwrite it if that's what the user runs.
</p>

<p>
Make a symbolic link from $(DIRECTORY) to Mesa.  For example,
ln -s Mesa Mesa-3.3    This is needed in order to make a correct
tar file in the next step.
</p>

<p>
Make the distribution files.  From inside the Mesa directory:
<pre>
	make -f Makefile.X11 lib_tar
	make -f Makefile.X11 demo_tar
	make -f Makefile.X11 lib_zip
	make -f Makefile.X11 demo_zip
</pre>

<p>
Copy the distribution files to a temporary directory, unpack them,
compile everything, and run some demos to be sure everything works.
</p>

<p>
Upload the *.tar.gz and *.zip files to ftp.mesa3d.org
</p>

<p>
Update the web site.
</p>

<p>
Make an announcement on the mailing lists:
<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>,
<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>
and
<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>
</p>


<H2>Autoconf info</H2>

<p>
In order to run the bootstrap script you'll need:
<p>
<pre>
autoconf 2.50
automake 1.4-p5
libtool 1.4
</pre>


</body>
</html>