docs/devinfo.html

   1 <HTML>
   2
   3 <TITLE>Development Notes</TITLE>
   4
   5 <link rel="stylesheet" type="text/css" href="mesa.css"></head>
   6
   7 <BODY>
   8
   9 <H1>Development Notes</H1>
  10
  11
  12 <H2>Adding Extentions</H2>
  13
  14 <p>
  15 To add a new GL extension to Mesa you have to do at least the following.
  16
  17 <ul>
  18 <li>
  19    If glext.h doesn't define the extension, edit include/GL/gl.h and add
  20    code like this:
  21    <pre>
  22      #ifndef GL_EXT_the_extension_name
  23      #define GL_EXT_the_extension_name 1
  24      /* declare the new enum tokens */
  25      /* prototype the new functions */
  26      /* TYPEDEFS for the new functions */
  27      #endif
  28    </pre>
  29 </li>
  30 <li>
  31    In the src/mesa/glapi/ directory, add the new extension functions and
  32    enums to the gl_API.xml file.
  33    Then, a bunch of source files must be regenerated by executing the
  34    corresponding Python scripts.
  35 </li>
  36 <li>
  37    Add a new entry to the <code>gl_extensions</code> struct in mtypes.h
  38 </li>
  39 <li>
  40    Update the <code>extensions.c</code> file.
  41 </li>
  42 <li>
  43    From this point, the best way to proceed is to find another extension,
  44    similar to the new one, that's already implemented in Mesa and use it
  45    as an example.
  46 </li>
  47 <li>
  48    If the new extension adds new GL state, the functions in get.c, enable.c
  49    and attrib.c will most likely require new code.
  50 </li>
  51 </ul>
  52
  53
  54
  55 <H2>Coding Style</H2>
  56
  57 <p>
  58 Mesa's code style has changed over the years.  Here's the latest.
  59 </p>
  60
  61 <p>
  62 Comment your code!  It's extremely important that open-source code be
  63 well documented.  Also, strive to write clean, easily understandable code.
  64 </p>
  65
  66 <p>
  67 3-space indentation
  68 </p>
  69
  70 <p>
  71 If you use tabs, set them to 8 columns
  72 </p>
  73
  74 <p>
  75 Brace example:
  76 </p>
  77 <pre>
  78         if (condition) {
  79            foo;
  80         }
  81         else {
  82            bar;
  83         }
  84 </pre>
  85
  86 <p>
  87 Here's the GNU indent command which will best approximate my preferred style:
  88 </p>
  89 <pre>
  90         indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
  91 </pre>
  92
  93
  94 <p>
  95 Local variable name example:  localVarName (no underscores)
  96 </p>
  97
  98 <p>
  99 Constants and macros are ALL_UPPERCASE, with _ between words
 100 </p>
 101
 102 <p>
 103 Global variables are not allowed.
 104 </p>
 105
 106 <p>
 107 Function name examples:
 108 </p>
 109 <pre>
 110         glFooBar()       - a public GL entry point (in glapi_dispatch.c)
 111         _mesa_FooBar()   - the internal immediate mode function
 112         save_FooBar()    - retained mode (display list) function in dlist.c
 113         foo_bar()        - a static (private) function
 114         _mesa_foo_bar()  - an internal non-static Mesa function
 115 </pre>
 116
 117
 118 <H2>Making a New Mesa Release</H2>
 119
 120 <p>
 121 These are the instructions for making a new Mesa release.
 122 </p>
 123
 124 <H3>Get latest source files</H3>
 125 <p>
 126 Use git to get the latest Mesa files from the git repository, from whatever
 127 branch is relevant.
 128 </p>
 129
 130
 131 <H3>Verify and update version info</H3>
 132 <p>
 133 Create/edit the docs/relnotes-x.y.html file to document what's new in the release.
 134 Add the new relnotes-x.y.html file to <a href="relnotes.html">relnotes.html</a>.
 135 </p>
 136
 137 <p>
 138 Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in
 139 configs/default.
 140 Also update the VERSION line in the top-level Makefile.
 141 </p>
 142
 143 <p>
 144 Make sure the values in src/mesa/main/version.h are correct.
 145 </p>
 146
 147 <p>
 148 Update docs/news.html.
 149 </p>
 150
 151 <p>
 152 Check in all updates to git.
 153 </p>
 154
 155 <p>
 156 Tag the files with the release name (in the form <b>mesa_X_Y</b>)
 157 with: <code>git tag -a mesa_X_Y</code>
 158 Then: <code>git push origin mesa_X_Y</code>
 159 </p>
 160
 161
 162 <H3>Make the tarballs</H3>
 163 <p>
 164 Make a symbolic link from $(DIRECTORY) to 'Mesa'.  For example,
 165 <code>ln -s Mesa Mesa-7.5</code>
 166 This is needed in order to make a correct tar file in the next step.
 167 </p>
 168
 169 <p>
 170 Make the distribution files.  From inside the Mesa directory:
 171 <pre>
 172         make tarballs
 173 </pre>
 174
 175 <p>
 176 After the tarballs are created, the md5 checksums for the files will
 177 be computed.
 178 Add them to the docs/relnotes-X.Y.html file.
 179 </p>
 180
 181 <p>
 182 Copy the distribution files to a temporary directory, unpack them,
 183 compile everything, and run some demos to be sure everything works.
 184 </p>
 185
 186 <H3>Update the website and announce the release</H3>
 187 <p>
 188 Follow the directions on SourceForge for creating a new "release" and
 189 uploading the tarballs.
 190 </p>
 191
 192 <p>
 193 Basically, to upload the tarball files with:
 194 <br>
 195 <code>
 196 rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/
 197 </code>
 198 </p>
 199
 200 <p>
 201 Update the web site by copying the docs/ directory's files to
 202 /home/users/b/br/brianp/mesa-www/htdocs/ with:
 203 <br>
 204 <code>
 205 sftp USERNAME,mesa3d@web.sourceforge.net
 206 </code>
 207 </p>
 208
 209 <p>
 210 Make an announcement on the mailing lists:
 211
 212 <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>,
 213 <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>
 214 and
 215 <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>
 216 </p>
 217
 218
 219
 220 </body>
 221 </html>