Squashed commit of the following:
[mesa.git] / docs / devinfo.html
index c1ddea3e4b955bc65626f6b397e42c1dce0e6cc4..8887dd02624a8ca5eb602aab861bdeddd8b193f6 100644 (file)
@@ -2,7 +2,9 @@
 
 <TITLE>Development Notes</TITLE>
 
-<BODY text="#000000" bgcolor="#55bbff" link="#111188">
+<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+
+<BODY>
 
 <H1>Development Notes</H1>
 
@@ -32,14 +34,18 @@ To add a new GL extension to Mesa you have to do at least the following.
    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.
+   Add a new entry to the <code>gl_extensions</code> struct in mtypes.h
+</li>
+<li>
+   Update the <code>extensions.c</code> file.
 </li>
 <li>
-   If hew extension adds new GL state, the functions in get.c, enable.c
+   From this point, the best way to proceed is to find another extension,
+   similar to the new one, that's already implemented in Mesa and use it
+   as an example.
+</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>
@@ -81,7 +87,7 @@ Brace example:
 Here's the GNU indent command which will best approximate my preferred style:
 </p>
 <pre>
-       indent -br -i3 -npcs infile.c -o outfile.c
+       indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
 </pre>
 
 
@@ -94,14 +100,14 @@ Constants and macros are ALL_UPPERCASE, with _ between words
 </p>
 
 <p>
-Global vars not allowed.
+Global variables are not allowed.
 </p>
 
 <p>
 Function name examples:
 </p>
 <pre>
-       glFooBar()       - a public GL entry point (in dispatch.c)
+       glFooBar()       - a public GL entry point (in glapi_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
@@ -109,132 +115,101 @@ 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 git to get the latest Mesa files from the git repository, from whatever
+branch is relevant.
 </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 definitions in src/version.h
+Create/edit the docs/relnotes-x.y.html file to document what's new in the release.
+Add the new relnotes-x.y.html file to <a href="relnotes.html">relnotes.html</a>.
 </p>
 
 <p>
-Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
-Edit the docs/VERSIONS file too.
+Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in
+configs/default.
+Also update the VERSION line in the top-level Makefile.
 </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 are 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.
+Update docs/news.html.
 </p>
 
 <p>
-Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
+Check in all updates to git.
 </p>
 
 <p>
-Verify the version numbers near the top of configure.in
+Tag the files with the release name (in the form <b>mesa_X_Y</b>)
+with: <code>git tag -a mesa_X_Y</code>
+Then: <code>git push origin mesa_X_Y</code>
 </p>
 
-<p>
-Run "fixam -f" to disable automatic dependency tracking.
-</p>
 
+<H3>Make the tarballs</H3>
 <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>
+Make the distribution files.  From inside the Mesa directory:
+<pre>
+       make tarballs
+</pre>
 
 <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.
+After the tarballs are created, the md5 checksums for the files will
+be computed.
+Add them to the docs/relnotes-X.Y.html file.
 </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.
+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>
-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.
+Follow the directions on SourceForge for creating a new "release" and
+uploading the tarballs.
 </p>
 
 <p>
-Upload the *.tar.gz and *.zip files to ftp.mesa3d.org
+Basically, to upload the tarball files with:
+<br>
+<code>
+rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/
+</code>
 </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/ with:
+<br>
+<code>
+sftp USERNAME,mesa3d@web.sourceforge.net
+</code>
 </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>
+
+<em>m</em><em>e</em><em>s</em><em>a</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>f</em><em>r</em><em>e</em><em>e</em><em>d</em><em>e</em><em>s</em><em>k</em><em>t</em><em>o</em><em>p</em><em>.</em><em>o</em><em>r</em><em>g</em>,
+<em>m</em><em>e</em><em>s</em><em>a</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>f</em><em>r</em><em>e</em><em>e</em><em>d</em><em>e</em><em>s</em><em>k</em><em>t</em><em>o</em><em>p</em><em>.</em><em>o</em><em>r</em><em>g</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>
+<em>m</em><em>e</em><em>s</em><em>a</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>f</em><em>r</em><em>e</em><em>e</em><em>d</em><em>e</em><em>s</em><em>k</em><em>t</em><em>o</em><em>p</em><em>.</em><em>o</em><em>r</em><em>g</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>