OSDN Git Service

glapi: add GL_OES_compressed_ETC1_RGB8_texture for GLES
[android-x86/external-mesa.git] / docs / devinfo.html
index 9fcd8cf..678e48c 100644 (file)
@@ -34,11 +34,15 @@ 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>
+   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
@@ -68,6 +72,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>
@@ -77,13 +88,29 @@ 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 infile.c -o outfile.c
+       indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
 </pre>
 
 
@@ -103,13 +130,23 @@ Global variables are not allowed.
 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>
 
+<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>
 
@@ -119,52 +156,44 @@ These are the instructions for making a new Mesa release.
 
 <H3>Get latest source files</H3>
 <p>
-Use "cvs update -dAP " to get the latest Mesa files from CVS.
+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 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>
-Edit configs/default and change the MESA_MAJOR, MESA_MINOR and MESA_TINY
-version numbers.
+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>
-Make sure the values in src/mesa/main/version.h is correct.
+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 the top-level Makefile and verify that DIRECTORY, LIB_NAME and
-DEMO_NAME are correct.
+Make sure the values in src/mesa/main/version.h are correct.
 </p>
 
 <p>
-Update the docs/news.html file and docs/contents.html files.
+Update docs/news.html.
 </p>
 
 <p>
-Check in all updates to CVS.
+Check in all updates to git.
 </p>
 
 <p>
-Tag the CVS files with the release name (in the form <b>mesa_X_Y</b>).
+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>
 <p>
-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 tarballs
@@ -173,7 +202,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/news.html file.
+Add them to the docs/relnotes-X.Y.html file.
 </p>
 
 <p>
@@ -188,16 +217,29 @@ uploading the tarballs.
 </p>
 
 <p>
+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 by copying the docs/ directory's files to 
-/home/users/b/br/brianp/mesa-www/htdocs/
+/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>