File: DEVINFO

package info (click to toggle)
mesa 3.1-17
  • links: PTS
  • area: main
  • in suites: potato
  • size: 10,908 kB
  • ctags: 19,599
  • sloc: ansic: 132,736; asm: 10,554; sh: 9,193; cpp: 3,540; makefile: 1,377
file content (143 lines) | stat: -rw-r--r-- 4,621 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143


                      Information for Mesa developers


Adding Extentions
-----------------

To add a new GL extension to Mesa you have to do the following.

   Edit include/GL/gl.h and add
	- new enum tokens
	- new API function entry points
	- #define GL_EXT_the_extension_name 1

   If adding a new API function (call it glNewFunctionEXT):
	- insert glNewFunctionEXT()into src/apiext.h
	- edit src/types.h and add NewFunction to the gl_api_table struct
	- implement gl_NewFunction() in the appropriate src file
	- hook gl_NewFunction() into pointers.c
	- add display list support in dlist.c for save_NewFunction()
	- add glNewFunctionEXT to gl_GetProcAddress() in extensions.c or
	  in the device driver's GetProcAddress() function if appropriate

   If adding new GL state be sure to update get.c and enable.c

   Document the extension in the README file.  Either include a pointer
   to the extension spec or write an extension spec and put it in the
   Mesa/docs/ directory.



Coding Style
------------

Mesa's code style has changed over the years.  Here's the latest.

Comment your code!  It's extremely important that open-source code be
well documented.  Also, strive to write clean, easily understandable code.

3-space indentation

If you use tabs, set them to 8 columns

Brace example:

	if (condition) {
	   foo;
	}
	else {
	   bar;
	}

Local variable name example:  localVarName (no underscores)

Constants and macros are ALL UPPERCASE, with _ between words

Global vars not allowed.  Think very seriously before adding a new global!

Function name examples:
	glFooBar()    - a public GL entry point
	gl_FooBar()   - the internal immediate mode function
	save_FooBar() - retained mode (display list) function in dlist.c
	foo_bar()     - a static (private) function
	gl_foo_bar()  - an internal Mesa function



Writing a Device Driver
-----------------------

XXX to do



Making a New Mesa Release
-------------------------

These are the instructions for making a new Mesa release.

Be sure to do a "cvs update -d ." in the Mesa directory to
get all the latest files.

Update the version strings in src/get.c, src-glu/glu.c, and
src/X/fakeglx.c to return the new Mesa version number.

Edit the docs/RELNOTES file to document what's new in the release.
Edit the docs/VERSIONS file too.
Update the docs/IAFA-PACKAGE file.

Edit the GNU configure stuff to change versions numbers as needed:
Update the version string (second argument) in the line
"AM_INIT_AUTOMAKE(Mesa, 3.1b3)".
Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE".
For both LIBGL_VERSION and LIBGLU_VERSION (libGL and libGLU version) do:
* If the library source code has changed at all since the last
  update, then increment REVISION (`C:R:A' becomes `C:R+1:A').
* If any interfaces have been added, removed, or changed since the
  last update, increment CURRENT, and set REVISION to 0.
* If any interfaces have been added since the last public release,
  then increment AGE.
* If any interfaces have been removed since the last public release,
  then set AGE to 0.

Run "fixam -f" to disable automatic dependency tracking.
Run the bootstrap script to generate the configure script.
(Requires autoconf 2.13 and automake 1.4, available from ftp.gnu.org)

Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions.

Edit Makefile.X11 and verify DIRECTORY is set correctly.  The Mesa
sources must be in that directory (or there must be a symbolic link).

Edit Makefile.X11 and verify that LIB_NAME and DEMO_NAME are correct.
If it's a beta release, be sure the bump up the beta release number.

cp Makefile.X11 to Makefile so that the old-style Mesa makefiles
still work.  ./configure will overwrite it if that's what the user runs.

Make a symbolic link from $(DIRECTORY) to Mesa.  For example,
ln -s Mesa Mesa-3.1    This is needed in order to make a correct
tar file in the next step.

Make the distribution files.  From inside the Mesa directory:
	make -f Makefile.X11 lib_tar
	make -f Makefile.X11 demo_tar
	make -f Makefile.X11 lib_zip
	make -f Makefile.X11 demo_zip

Copy the distribution files to a temporary directory, unpack them,
compile everything, and run some demos to be sure everything works.

Upload the *.tar.gz and *.zip files to ftp.mesa3d.org

Update the web site.  CJ Beyer (cj@styx.phy.vanderbilt.edu) can
help with this and uploading to the ftp site.

Make the announcement to mesa-dev@mesa3d.org, mesa@iqm.unicamp.br,
mesa-announce@iqm.unicamp.br and other sites.


----------------------------------------------------------------------
$Id: DEVINFO,v 1.7 1999/09/19 20:09:00 tanner Exp $