diff options
| author | Jonathan Gray <jsg@cvs.openbsd.org> | 2013-09-05 14:07:04 +0000 |
|---|---|---|
| committer | Jonathan Gray <jsg@cvs.openbsd.org> | 2013-09-05 14:07:04 +0000 |
| commit | 821893da535a9c114e427454fe97ee8db13dafbd (patch) | |
| tree | 5fac22b58520a25347ff8fada5894ca5c8a9b10c /dist/Mesa/docs/devinfo.html | |
| parent | d0da870fb1db8146fc38e88a1f9b10c37890c46c (diff) | |
Merge Mesa 9.2.0
Diffstat (limited to 'dist/Mesa/docs/devinfo.html')
| -rw-r--r-- | dist/Mesa/docs/devinfo.html | 137 |
1 files changed, 98 insertions, 39 deletions
diff --git a/dist/Mesa/docs/devinfo.html b/dist/Mesa/docs/devinfo.html index 2d1c125e8..5aad0fb1d 100644 --- a/dist/Mesa/docs/devinfo.html +++ b/dist/Mesa/docs/devinfo.html @@ -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. @@ -72,6 +80,13 @@ 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> <pre> @@ -81,10 +96,26 @@ Brace example: 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 --no-tabs infile.c -o outfile.c @@ -114,68 +145,94 @@ 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 <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>Marking a commit as a candidate for a stable branch</h2> <p> -These are the instructions for making a new Mesa release. +If you want a commit to be applied to a stable branch, +you should add an appropriate note to the commit message. </p> -<H3>Get latest source files</H3> <p> -Use git to get the latest Mesa files from the git repository, from whatever -branch is relevant. +Here are some examples of such a note: </p> +<ul> + <li>NOTE: This is a candidate for the 9.0 branch.</li> + <li>NOTE: This is a candidate for the 8.0 and 9.0 branches.</li> + <li>NOTE: This is a candidate for the stable branches.</li> +</ul> -<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> +<h2>Cherry-picking candidates for a stable branch</h2> <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. +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> -Make sure the values in src/mesa/main/version.h are correct. +These are the instructions for making a new Mesa release. </p> +<h3>Get latest source files</h3> <p> -Update docs/news.html. +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> + +<dl> + <dt>SConstruct</dt> + <dt>Android.common.mk</dt> + <dd>PACKAGE_VERSION</dd> + <dt>configure.ac</dt> + <dd>AC_INIT</dd> +</dl> + <p> -Check in all updates to git. +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> -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> +Update <a href="index.html">docs/index.html</a>. </p> - -<H3>Make the tarballs</H3> <p> -Make a symbolic link from $(DIRECTORY) to 'Mesa'. For example, -<code>ln -s Mesa Mesa-7.5</code> -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> + ./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. +Add them to the docs/relnotes/x.y.html file. </p> <p> @@ -183,17 +240,20 @@ 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. +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> Basically, to upload the tarball files with: <br> <code> -rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/ +rsync -avP -e ssh MesaLib-x.y.* USERNAME@annarchy.freedesktop.org:/srv/ftp.freedesktop.org/pub/mesa/x.y/ </code> </p> @@ -215,7 +275,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> |