2003-03-08 17:38:57 +00:00
|
|
|
<HTML>
|
|
|
|
|
|
|
|
|
|
<TITLE>Development Notes</TITLE>
|
|
|
|
|
|
|
|
|
|
<BODY text="#000000" bgcolor="#55bbff" link="#111188">
|
|
|
|
|
|
|
|
|
|
<H1>Development Notes</H1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<H2>Adding Extentions</H2>
|
|
|
|
|
|
|
|
|
|
<p>
|
2004-08-17 15:08:59 +01:00
|
|
|
To add a new GL extension to Mesa you have to do at least the following.
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li>
|
|
|
|
|
If glext.h doesn't define the extension, edit include/GL/gl.h and add
|
|
|
|
|
code like this:
|
|
|
|
|
<pre>
|
|
|
|
|
#ifndef GL_EXT_the_extension_name
|
|
|
|
|
#define GL_EXT_the_extension_name 1
|
|
|
|
|
/* declare the new enum tokens */
|
|
|
|
|
/* prototype the new functions */
|
|
|
|
|
/* TYPEDEFS for the new functions */
|
|
|
|
|
#endif
|
|
|
|
|
</pre>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
In the src/mesa/glapi/ directory, add the new extension functions and
|
|
|
|
|
enums to the gl_API.xml file.
|
|
|
|
|
Then, a bunch of source files must be regenerated by executing the
|
|
|
|
|
corresponding Python scripts.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
Find an existing extension that's similar to the new one and search
|
|
|
|
|
the sources for code related to that extension.
|
|
|
|
|
Implement new code as needed.
|
|
|
|
|
In general, new state variables will be added to mtypes.h. If the
|
|
|
|
|
extension is rather large, try to implement it in a new source file.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
If hew extension adds new GL state, the functions in get.c, enable.c
|
|
|
|
|
and attrib.c will most likely require new code.
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2003-03-08 17:38:57 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
2003-06-01 17:28:00 +01:00
|
|
|
Update the version definitions in src/version.h
|
2003-03-08 17:38:57 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
2003-06-01 17:28:00 +01:00
|
|
|
Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
|
2003-03-08 17:38:57 +00:00
|
|
|
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>
|
2003-03-19 19:15:28 +00:00
|
|
|
Update the web site.
|
2003-03-08 17:38:57 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
2003-03-19 19:15:28 +00:00
|
|
|
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>
|
2003-03-08 17:38:57 +00:00
|
|
|
</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>
|
