-<HTML>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8">
+ <title>Development Notes</title>
+ <link rel="stylesheet" type="text/css" href="mesa.css">
+</head>
+<body>
-<TITLE>Development Notes</TITLE>
+<div class="header">
+ <h1>The Mesa 3D Graphics Library</h1>
+</div>
-<BODY text="#000000" bgcolor="#55bbff" link="#111188">
+<iframe src="contents.html"></iframe>
+<div class="content">
-<H1>Development Notes</H1>
+<h1>Development Notes</h1>
-<H2>Adding Extentions</H2>
+<h2>Adding Extensions</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/mapi/glapi/gen/ 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>
+ 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>
+ 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>
+<li>
+ The dispatch tests check_table.cpp and dispatch_sanity.cpp
+ should be updated with details about the new extensions functions. These
+ tests are run using 'make check'
+</li>
+</ul>
-<H2>Coding Style</H2>
+<h2>Coding Style</h2>
<p>
Mesa's code style has changed over the years. Here's the latest.
If you use tabs, set them to 8 columns
</p>
+<p>
+Line width: the preferred width to fill comments and code in Mesa is 78
+columns. Exceptions are sometimes made for clarity (e.g. tabular data is
+sometimes filled to a much larger width so that extraneous carriage returns
+don't obscure the table).
+</p>
+
<p>
Brace example:
</p>
else {
bar;
}
+
+ switch (condition) {
+ case 0:
+ foo();
+ break;
+
+ case 1: {
+ ...
+ break;
+ }
+
+ default:
+ ...
+ break;
+ }
</pre>
<p>
Here's the GNU indent command which will best approximate my preferred style:
+(Note that it won't format switch statements in the preferred way)
</p>
<pre>
- indent -br -i3 -npcs infile.c -o outfile.c
+ indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
</pre>
</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
_mesa_foo_bar() - an internal non-static Mesa function
</pre>
-
-<H2>Writing a Device Driver</H2>
-
<p>
-XXX to do
+Places that are not directly visible to the GL API should prefer the use
+of <tt>bool</tt>, <tt>true</tt>, and
+<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and
+<tt>GL_FALSE</tt>. In C code, this may mean that
+<tt>#include <stdbool.h></tt> needs to be added. The
+<tt>try_emit_</tt>* methods in src/mesa/program/ir_to_mesa.cpp and
+src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
</p>
-
-
-<H2>Making a New Mesa Release</H2>
+<h2>Submitting patches</h2>
<p>
-These are the instructions for making a new Mesa release.
+You should always run the Mesa Testsuite before submitting patches.
+The Testsuite can be run using the 'make check' command. All tests
+must pass before patches will be accepted, this may mean you have
+to update the tests themselves.
</p>
<p>
-Prerequisites (later versions may work):
+Patches should be sent to the Mesa mailing list for review.
+When submitting a patch make sure to use git send-email rather than attaching
+patches to emails. Sending patches as attachments prevents people from being
+able to provide in-line review comments.
</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.
+When submitting follow-up patches you can use --in-reply-to to make v2, v3,
+etc patches show up as replies to the originals. This usually works well
+when you're sending out updates to individual patches (as opposed to
+re-sending the whole series). Using --in-reply-to makes
+it harder for reviewers to accidentally review old patches.
</p>
-<p>
-Update the version definitions in src/version.h
-</p>
+<h2>Marking a commit as a candidate for a stable branch</h2>
<p>
-Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
-Edit the docs/VERSIONS file too.
+If you want a commit to be applied to a stable branch,
+you should add an appropriate note to the commit message.
</p>
<p>
-Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions.
+Here are some examples of such a note:
</p>
+<ul>
+ <li>CC: <mesa-stable@lists.freedesktop.org></li>
+ <li>CC: "9.2 10.0" <mesa-stable@lists.freedesktop.org></li>
+ <li>CC: "10.0" <mesa-stable@lists.freedesktop.org></li>
+</ul>
-<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>
+Simply adding the CC to the mesa-stable list address is adequate to nominate
+the commit for the most-recently-created stable branch. It is only necessary
+to specify a specific branch name, (such as "9.2 10.0" or "10.0" in the
+examples above), if you want to nominate the commit for an older stable
+branch. And, as in these examples, you can nominate the commit for the older
+branch in addition to the more recent branch, or nominate the commit
+exclusively for the older branch.
-<p>
-Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
-</p>
+This "CC" syntax for patch nomination will cause patches to automatically be
+copied to the mesa-stable@ mailing list when you use "git send-email" to send
+patches to the mesa-dev@ mailing list. Also, if you realize that a commit
+should be nominated for the stable branch after it has already been committed,
+you can send a note directly to the mesa-stable@lists.freedesktop.org where
+the Mesa stable-branch maintainers will receive it. Be sure to mention the
+commit ID of the commit of interest (as it appears in the mesa master branch).
-<p>
-Verify the version numbers near the top of configure.in
-</p>
+The latest set of patches that have been nominated, accepted, or rejected for
+the upcoming stable release can always be seen on the
+<a href=http://cworth.org/~cworth/mesa-stable-queue/">Mesa Stable Queue</a>
+page.
+
+<h2>Cherry-picking candidates for a stable branch</h2>
<p>
-Run "fixam -f" to disable automatic dependency tracking.
+Please use <code>git cherry-pick -x <commit></code> for cherry-picking a commit
+from master to a stable branch.
</p>
+<h2>Making a New Mesa Release</h2>
+
<p>
-Run the bootstrap script to generate the configure script.
+These are the instructions for making a new Mesa release.
</p>
+<h3>Get latest source files</h3>
<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).
+Use git to get the latest Mesa files from the git repository, from whatever
+branch is relevant.
</p>
+
+<h3>Verify and update version info in VERSION</h3>
+
<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.
+Create a docs/relnotes/x.y.z.html file.
+The bin/bugzilla_mesa.sh and bin/shortlog_mesa.sh scripts can be used to
+create the HTML-formatted lists of bugfixes and changes to include in the file.
+Link the new docs/relnotes/x.y.z.html file into the main <a href="relnotes.html">relnotes.html</a> file.
</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.
+Update <a href="index.html">docs/index.html</a>.
</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.
+Tag the files with the release name (in the form <b>mesa-x.y</b>)
+with: <code>git tag -s mesa-x.y -m "Mesa x.y Release"</code>
+Then: <code>git push origin mesa-x.y</code>
</p>
+
+<h3>Make the tarballs</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
+ ./autogen.sh
+ make tarballs
</pre>
+<p>
+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>
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
+Make a new directory for the release on annarchy.freedesktop.org with:
+<br>
+<code>
+mkdir /srv/ftp.freedesktop.org/pub/mesa/x.y
+</code>
</p>
<p>
-Update the web site.
+Basically, to upload the tarball files with:
+<br>
+<code>
+rsync -avP -e ssh MesaLib-x.y.* USERNAME@annarchy.freedesktop.org:/srv/ftp.freedesktop.org/pub/mesa/x.y/
+</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>
-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>
+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>
-
-<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>
+Make an announcement on the mailing lists:
+<em>mesa-dev@lists.freedesktop.org</em>,
+<em>mesa-users@lists.freedesktop.org</em>
+and
+<em>mesa-announce@lists.freedesktop.org</em>
+</p>
+</div>
</body>
</html>
projects / mesa.git / blobdiff