minor info update
[mesa.git] / docs / devinfo.html
index 398637c51c5ad1c574eff9920f05bf78615935ae..498b713e5c2ef87558b43ee766f66cc90009518a 100644 (file)
 <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>
+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 the new extension adds new GL state, the functions in get.c, enable.c
+   and attrib.c will most likely require new code.
+</li>
+</ul>
 
 
 
@@ -84,7 +94,7 @@ Constants and macros are ALL_UPPERCASE, with _ between words
 </p>
 
 <p>
-Global vars not allowed.
+Global variables are not allowed.
 </p>
 
 <p>
@@ -99,111 +109,85 @@ Function name examples:
 </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>
 
+<H3>Get latest source files</H3>
 <p>
-Prerequisites (later versions may work):
+Use "cvs update -dAP " to get the latest Mesa files from CVS.
 </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>
 
+<H3>Verify and update version info</H3>
 <p>
-Update the version strings in src/get.c and src/X/fakeglx.c to return
-the new Mesa version number.
+Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
+Add the new RELNOTES-X.Y file to <a href="relnotes.html">relnotes.html</a>.
+Update the docs/VERSIONS file too.
 </p>
 
 <p>
-Create/edit the docs/RELNOTES-X-Y file to document what's new in the release.
-Edit the docs/VERSIONS file too.
+Edit configs/default and change the MESA_MAJOR, MESA_MINOR and MESA_TINY
+version numbers.
 </p>
 
 <p>
-Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions.
+Make sure the values in src/mesa/main/version.h is correct.
 </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.
+Edit the top-level Makefile and verify that DIRECTORY, LIB_NAME and
+DEMO_NAME are correct.
 </p>
 
 <p>
-Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
+Update the docs/news.html file and docs/contents.html files.
 </p>
 
 <p>
-Verify the version numbers near the top of configure.in
+Check in all updates to CVS.
 </p>
 
 <p>
-Run "fixam -f" to disable automatic dependency tracking.
+Tag the CVS files with the release name (in the form <b>mesa_X_Y</b>).
 </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>
 
+<H3>Make the tarballs</H3>
 <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.
+Make a symbolic link from $(DIRECTORY) to 'Mesa'.  For example,
+ln -s Mesa Mesa-6.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
+       make tarballs
 </pre>
 
+<p>
+After the tarballs are created, the md5 checksums for the files will
+be computed.
+Add them to the docs/news.html file.
+</p>
+
 <p>
 Copy the distribution files to a temporary directory, unpack them,
 compile everything, and run some demos to be sure everything works.
 </p>
 
+<H3>Update the website and announce the release</H3>
 <p>
-Upload the *.tar.gz and *.zip files to ftp.mesa3d.org
+Follow the directions on SourceForge for creating a new "release" and
+uploading the tarballs.
 </p>
 
 <p>
-Update the web site.
+Update the web site by copying the docs/ directory's files to 
+/home/users/b/br/brianp/mesa-www/htdocs/
 </p>
 
 <p>
@@ -215,17 +199,6 @@ and
 </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>