mesa: consolidate subtexture xoffset/yoffset/width/height error checking code
[mesa.git] / docs / devinfo.html
index c0966480ab7a2fe1f5b4e25aa60474b11c18cb63..90752b750e83c53f97379f5535cf0d8f868b44f9 100644 (file)
@@ -1,15 +1,23 @@
-<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>
 
-<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+<iframe src="contents.html"></iframe>
+<div class="content">
 
-<BODY>
+<h1>Development Notes</h1>
 
-<H1>Development Notes</H1>
 
-
-<H2>Adding Extentions</H2>
+<h2>Adding Extentions</h2>
 
 <p>
 To add a new GL extension to Mesa you have to do at least the following.
@@ -52,7 +60,7 @@ To add a new GL extension to Mesa you have to do at least the following.
 
 
 
-<H2>Coding Style</H2>
+<h2>Coding Style</h2>
 
 <p>
 Mesa's code style has changed over the years.  Here's the latest.
@@ -137,52 +145,62 @@ Function name examples:
        _mesa_foo_bar()  - an internal non-static Mesa function
 </pre>
 
+<p>
+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 &lt;stdbool.h&gt;</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>Making a New Mesa Release</h2>
 
 <p>
 These are the instructions for making a new Mesa release.
 </p>
 
-<H3>Get latest source files</H3>
+<h3>Get latest source files</h3>
 <p>
 Use git to get the latest Mesa files from the git repository, from whatever
 branch is relevant.
 </p>
 
 
-<H3>Verify and update version info</H3>
-<p>
-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>
+<h3>Verify and update version info</h3>
 
-<p>
-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>
-Make sure the values in src/mesa/main/version.h are correct.
-</p>
+<dl>
+  <dt>configs/default</dt>
+  <dd>MESA_MAJOR, MESA_MINOR and MESA_TINY</dd>
+  <dt>Makefile.am</dt>
+  <dd>PACKAGE_VERSION</dd>
+  <dt>configure.ac</dt>
+  <dd>AC_INIT</dd>
+  <dt>src/mesa/main/version.h</dt>
+  <dd>MESA_MAJOR, MESA_MINOR, MESA_PATCH and MESA_VERSION_STRING</dd>
+</dl>
 
 <p>
-Update docs/news.html.
+Create a docs/relnotes-x.y.z.html file.
+The bin/shortlog_mesa.sh script can be used to create a HTML-formatted list
+of 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>
-Check in all updates to git.
+Update <a href="index.html">docs/index.html</a>.
 </p>
 
 <p>
-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>
+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>
 
 
-<H3>Make the tarballs</H3>
+<h3>Make the tarballs</h3>
 <p>
 Make the distribution files.  From inside the Mesa directory:
 <pre>
@@ -192,7 +210,7 @@ Make the distribution files.  From inside the Mesa directory:
 <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.
+Add them to the docs/relnotes-x.y.html file.
 </p>
 
 <p>
@@ -200,7 +218,7 @@ 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>
+<h3>Update the website and announce the release</h3>
 <p>
 Follow the directions on SourceForge for creating a new "release" and
 uploading the tarballs.
@@ -232,7 +250,6 @@ and
 <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>
 
-
-
+</div>
 </body>
 </html>