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 Line width: the preferred width to fill comments and code in Mesa is 78
  76 columns.  Exceptions are sometimes made for clarity (e.g. tabular data is
  77 sometimes filled to a much larger width so that extraneous carriage returns
  78 don't obscure the table).
  79 </p>
  80
  81 <p>
  82 Brace example:
  83 </p>
  84 <pre>
  85         if (condition) {
  86            foo;
  87         }
  88         else {
  89            bar;
  90         }
  91
  92         switch (condition) {
  93         case 0:
  94            foo();
  95            break;
  96
  97         case 1: {
  98            ...
  99            break;
 100         }
 101
 102         default:
 103            ...
 104            break;
 105         }
 106 </pre>
 107
 108 <p>
 109 Here's the GNU indent command which will best approximate my preferred style:
 110 (Note that it won't format switch statements in the preferred way)
 111 </p>
 112 <pre>
 113         indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
 114 </pre>
 115
 116
 117 <p>
 118 Local variable name example:  localVarName (no underscores)
 119 </p>
 120
 121 <p>
 122 Constants and macros are ALL_UPPERCASE, with _ between words
 123 </p>
 124
 125 <p>
 126 Global variables are not allowed.
 127 </p>
 128
 129 <p>
 130 Function name examples:
 131 </p>
 132 <pre>
 133         glFooBar()       - a public GL entry point (in glapi_dispatch.c)
 134         _mesa_FooBar()   - the internal immediate mode function
 135         save_FooBar()    - retained mode (display list) function in dlist.c
 136         foo_bar()        - a static (private) function
 137         _mesa_foo_bar()  - an internal non-static Mesa function
 138 </pre>
 139
 140
 141 <H2>Making a New Mesa Release</H2>
 142
 143 <p>
 144 These are the instructions for making a new Mesa release.
 145 </p>
 146
 147 <H3>Get latest source files</H3>
 148 <p>
 149 Use git to get the latest Mesa files from the git repository, from whatever
 150 branch is relevant.
 151 </p>
 152
 153
 154 <H3>Verify and update version info</H3>
 155 <p>
 156 Create/edit the docs/relnotes-x.y.html file to document what's new in the release.
 157 Add the new relnotes-x.y.html file to <a href="relnotes.html">relnotes.html</a>.
 158 </p>
 159
 160 <p>
 161 Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in
 162 configs/default.
 163 Also update the VERSION line in the top-level Makefile.
 164 </p>
 165
 166 <p>
 167 Make sure the values in src/mesa/main/version.h are correct.
 168 </p>
 169
 170 <p>
 171 Update docs/news.html.
 172 </p>
 173
 174 <p>
 175 Check in all updates to git.
 176 </p>
 177
 178 <p>
 179 Tag the files with the release name (in the form <b>mesa_X_Y</b>)
 180 with: <code>git tag -a mesa_X_Y</code>
 181 Then: <code>git push origin mesa_X_Y</code>
 182 </p>
 183
 184
 185 <H3>Make the tarballs</H3>
 186 <p>
 187 Make the distribution files.  From inside the Mesa directory:
 188 <pre>
 189         make tarballs
 190 </pre>
 191
 192 <p>
 193 After the tarballs are created, the md5 checksums for the files will
 194 be computed.
 195 Add them to the docs/relnotes-X.Y.html file.
 196 </p>
 197
 198 <p>
 199 Copy the distribution files to a temporary directory, unpack them,
 200 compile everything, and run some demos to be sure everything works.
 201 </p>
 202
 203 <H3>Update the website and announce the release</H3>
 204 <p>
 205 Follow the directions on SourceForge for creating a new "release" and
 206 uploading the tarballs.
 207 </p>
 208
 209 <p>
 210 Basically, to upload the tarball files with:
 211 <br>
 212 <code>
 213 rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/
 214 </code>
 215 </p>
 216
 217 <p>
 218 Update the web site by copying the docs/ directory's files to
 219 /home/users/b/br/brianp/mesa-www/htdocs/ with:
 220 <br>
 221 <code>
 222 sftp USERNAME,mesa3d@web.sourceforge.net
 223 </code>
 224 </p>
 225
 226 <p>
 227 Make an announcement on the mailing lists:
 228
 229 <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>,
 230 <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>
 231 and
 232 <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>
 233 </p>
 234
 235
 236
 237 </body>
 238 </html>