docs/devinfo.html

   1 <HTML>
   2
   3 <TITLE>Development Notes</TITLE>
   4
   5 <BODY text="#000000" bgcolor="#55bbff" link="#111188">
   6
   7 <H1>Development Notes</H1>
   8
   9
  10 <H2>Adding Extentions</H2>
  11
  12 <p>
  13 To add a new GL extension to Mesa you have to do at least the following.
  14
  15 <ul>
  16 <li>
  17    If glext.h doesn't define the extension, edit include/GL/gl.h and add
  18    code like this:
  19    <pre>
  20      #ifndef GL_EXT_the_extension_name
  21      #define GL_EXT_the_extension_name 1
  22      /* declare the new enum tokens */
  23      /* prototype the new functions */
  24      /* TYPEDEFS for the new functions */
  25      #endif
  26    </pre>
  27 </li>
  28 <li>
  29    In the src/mesa/glapi/ directory, add the new extension functions and
  30    enums to the gl_API.xml file.
  31    Then, a bunch of source files must be regenerated by executing the
  32    corresponding Python scripts.
  33 </li>
  34 <li>
  35    Find an existing extension that's similar to the new one and search
  36    the sources for code related to that extension.
  37    Implement new code as needed.
  38    In general, new state variables will be added to mtypes.h.  If the
  39    extension is rather large, try to implement it in a new source file.
  40 </li>
  41 <li>
  42    If hew extension adds new GL state, the functions in get.c, enable.c
  43    and attrib.c will most likely require new code.
  44 </li>
  45 </ul>
  46
  47
  48
  49 <H2>Coding Style</H2>
  50
  51 <p>
  52 Mesa's code style has changed over the years.  Here's the latest.
  53 </p>
  54
  55 <p>
  56 Comment your code!  It's extremely important that open-source code be
  57 well documented.  Also, strive to write clean, easily understandable code.
  58 </p>
  59
  60 <p>
  61 3-space indentation
  62 </p>
  63
  64 <p>
  65 If you use tabs, set them to 8 columns
  66 </p>
  67
  68 <p>
  69 Brace example:
  70 </p>
  71 <pre>
  72         if (condition) {
  73            foo;
  74         }
  75         else {
  76            bar;
  77         }
  78 </pre>
  79
  80 <p>
  81 Here's the GNU indent command which will best approximate my preferred style:
  82 </p>
  83 <pre>
  84         indent -br -i3 -npcs infile.c -o outfile.c
  85 </pre>
  86
  87
  88 <p>
  89 Local variable name example:  localVarName (no underscores)
  90 </p>
  91
  92 <p>
  93 Constants and macros are ALL_UPPERCASE, with _ between words
  94 </p>
  95
  96 <p>
  97 Global vars not allowed.
  98 </p>
  99
 100 <p>
 101 Function name examples:
 102 </p>
 103 <pre>
 104         glFooBar()       - a public GL entry point (in dispatch.c)
 105         _mesa_FooBar()   - the internal immediate mode function
 106         save_FooBar()    - retained mode (display list) function in dlist.c
 107         foo_bar()        - a static (private) function
 108         _mesa_foo_bar()  - an internal non-static Mesa function
 109 </pre>
 110
 111
 112 <H2>Writing a Device Driver</H2>
 113
 114 <p>
 115 XXX to do
 116 </p>
 117
 118
 119
 120 <H2>Making a New Mesa Release</H2>
 121
 122 <p>
 123 These are the instructions for making a new Mesa release.
 124 </p>
 125
 126 <p>
 127 Prerequisites (later versions may work):
 128 </p>
 129 <ul>
 130 <li>    autoconf 2.50
 131 <li>    automake 1.4-p2
 132 <li>    libtool 1.4
 133 </ul>
 134
 135 <p>
 136 Be sure to do a "cvs update -d ." in the Mesa directory to
 137 get all the latest files.
 138 </p>
 139
 140 <p>
 141 Update the version definitions in src/version.h
 142 </p>
 143
 144 <p>
 145 Create/edit the docs/RELNOTES-X.Y file to document what's new in the release.
 146 Edit the docs/VERSIONS file too.
 147 </p>
 148
 149 <p>
 150 Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions.
 151 </p>
 152
 153 <p>
 154 Edit the GNU configure stuff to change versions numbers as needed:
 155 Update the version string (second argument) in the line
 156 "AM_INIT_AUTOMAKE(Mesa, 3.3)" in the configure.in file.
 157 </p>
 158
 159 <p>
 160 Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
 161 </p>
 162
 163 <p>
 164 Verify the version numbers near the top of configure.in
 165 </p>
 166
 167 <p>
 168 Run "fixam -f" to disable automatic dependency tracking.
 169 </p>
 170
 171 <p>
 172 Run the bootstrap script to generate the configure script.
 173 </p>
 174
 175 <p>
 176 Edit Makefile.X11 and verify DIRECTORY is set correctly.  The Mesa
 177 sources must be in that directory (or there must be a symbolic link).
 178 </p>
 179
 180 <p>
 181 Edit Makefile.X11 and verify that LIB_NAME and DEMO_NAME are correct.
 182 If it's a beta release, be sure the bump up the beta release number.
 183 </p>
 184
 185 <p>
 186 cp Makefile.X11 to Makefile so that the old-style Mesa makefiles
 187 still work.  ./configure will overwrite it if that's what the user runs.
 188 </p>
 189
 190 <p>
 191 Make a symbolic link from $(DIRECTORY) to Mesa.  For example,
 192 ln -s Mesa Mesa-3.3    This is needed in order to make a correct
 193 tar file in the next step.
 194 </p>
 195
 196 <p>
 197 Make the distribution files.  From inside the Mesa directory:
 198 <pre>
 199         make -f Makefile.X11 lib_tar
 200         make -f Makefile.X11 demo_tar
 201         make -f Makefile.X11 lib_zip
 202         make -f Makefile.X11 demo_zip
 203 </pre>
 204
 205 <p>
 206 Copy the distribution files to a temporary directory, unpack them,
 207 compile everything, and run some demos to be sure everything works.
 208 </p>
 209
 210 <p>
 211 Upload the *.tar.gz and *.zip files to ftp.mesa3d.org
 212 </p>
 213
 214 <p>
 215 Update the web site.
 216 </p>
 217
 218 <p>
 219 Make an announcement on the mailing lists:
 220 <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>,
 221 <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>
 222 and
 223 <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>
 224 </p>
 225
 226
 227 <H2>Autoconf info</H2>
 228
 229 <p>
 230 In order to run the bootstrap script you'll need:
 231 <p>
 232 <pre>
 233 autoconf 2.50
 234 automake 1.4-p5
 235 libtool 1.4
 236 </pre>
 237
 238
 239 </body>
 240 </html>