From 807c6931fe683fd844ceec1b023232181e6aae03 Mon Sep 17 00:00:00 2001 From: marha Date: Tue, 28 Dec 2010 16:10:20 +0000 Subject: xserver and mesa git update 28-12-2010 --- mesalib/docs/devinfo.html | 441 +++++++++++++++++++++++----------------------- 1 file changed, 221 insertions(+), 220 deletions(-) (limited to 'mesalib/docs/devinfo.html') diff --git a/mesalib/docs/devinfo.html b/mesalib/docs/devinfo.html index df0e72652..b2cbf17b4 100644 --- a/mesalib/docs/devinfo.html +++ b/mesalib/docs/devinfo.html @@ -1,220 +1,221 @@ - - -Development Notes - - - - - -

Development Notes

- - -

Adding Extentions

- -

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

- If glext.h doesn't define the extension, edit include/GL/gl.h and add - code like this: -

-     #ifndef GL_EXT_the_extension_name
-     #define GL_EXT_the_extension_name 1
-     /* declare the new enum tokens */
-     /* prototype the new functions */
-     /* TYPEDEFS for the new functions */
-     #endif
-

- In the src/mesa/glapi/ directory, add the new extension functions and - enums to the gl_API.xml file. - Then, a bunch of source files must be regenerated by executing the - corresponding Python scripts. -
- Add a new entry to the gl_extensions struct in mtypes.h -
- Update the extensions.c file. -
- 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. -
- If the new extension adds new GL state, the functions in get.c, enable.c - and attrib.c will most likely require new code. -

- - - -

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;
-	}
-

- -

-Here's the GNU indent command which will best approximate my preferred style: -

-	indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
-

- - -

-Local variable name example: localVarName (no underscores) -

- -

-Constants and macros are ALL_UPPERCASE, with _ between words -

- -

-Global variables are not allowed. -

- -

-Function name examples: -

-	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
-

- - -

Making a New Mesa Release

- -

-These are the instructions for making a new Mesa release. -

- -

Get latest source files

-Use git to get the latest Mesa files from the git repository, from whatever -branch is relevant. -

- - -

Verify and update version info

-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 relnotes.html. -

- -

-Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in -configs/default. -Also update the VERSION line in the top-level Makefile. -

- -

-Make sure the values in src/mesa/main/version.h are correct. -

- -

-Update the docs/news.html file and docs/download.html files. -

- -

-Check in all updates to git. -

- -

-Tag the files with the release name (in the form mesa_X_Y) -with: git tag -a mesa_X_Y -Then: git push origin mesa_X_Y -

- - -

Make the tarballs

-Make a symbolic link from $(DIRECTORY) to 'Mesa'. For example, -ln -s Mesa Mesa-7.5 -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 tarballs
-

- -

-After the tarballs are created, the md5 checksums for the files will -be computed. -Add them to the docs/relnotes-X.Y.html file. -

- -

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

- -

Update the website and announce the release

-Follow the directions on SourceForge for creating a new "release" and -uploading the tarballs. -

- -

-Basically, to upload the tarball files with: -
--rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/ - -

- -

-Update the web site by copying the docs/ directory's files to -/home/users/b/br/brianp/mesa-www/htdocs/ with: -
--sftp USERNAME,mesa3d@web.sourceforge.net - -

- -

-Make an announcement on the mailing lists: -mesa3d-dev@lists.sf.net, -mesa3d-users@lists.sf.net -and -mesa3d-announce@lists.sf.net -

- - - - - + + +Development Notes + + + + + +

Development Notes

+ + +

Adding Extentions

+ +

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

+ If glext.h doesn't define the extension, edit include/GL/gl.h and add + code like this: +

+     #ifndef GL_EXT_the_extension_name
+     #define GL_EXT_the_extension_name 1
+     /* declare the new enum tokens */
+     /* prototype the new functions */
+     /* TYPEDEFS for the new functions */
+     #endif
+

+ In the src/mesa/glapi/ directory, add the new extension functions and + enums to the gl_API.xml file. + Then, a bunch of source files must be regenerated by executing the + corresponding Python scripts. +
+ Add a new entry to the gl_extensions struct in mtypes.h +
+ Update the extensions.c file. +
+ 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. +
+ If the new extension adds new GL state, the functions in get.c, enable.c + and attrib.c will most likely require new code. +

+ + + +

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;
+	}
+

+ +

+Here's the GNU indent command which will best approximate my preferred style: +

+	indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
+

+ + +

+Local variable name example: localVarName (no underscores) +

+ +

+Constants and macros are ALL_UPPERCASE, with _ between words +

+ +

+Global variables are not allowed. +

+ +

+Function name examples: +

+	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
+

+ + +

Making a New Mesa Release

+ +

+These are the instructions for making a new Mesa release. +

+ +

Get latest source files

+Use git to get the latest Mesa files from the git repository, from whatever +branch is relevant. +

+ + +

Verify and update version info

+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 relnotes.html. +

+ +

+Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in +configs/default. +Also update the VERSION line in the top-level Makefile. +

+ +

+Make sure the values in src/mesa/main/version.h are correct. +

+ +

+Update docs/news.html. +

+ +

+Check in all updates to git. +

+ +

+Tag the files with the release name (in the form mesa_X_Y) +with: git tag -a mesa_X_Y +Then: git push origin mesa_X_Y +

+ + +

Make the tarballs

+Make a symbolic link from $(DIRECTORY) to 'Mesa'. For example, +ln -s Mesa Mesa-7.5 +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 tarballs
+

+ +

+After the tarballs are created, the md5 checksums for the files will +be computed. +Add them to the docs/relnotes-X.Y.html file. +

+ +

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

+ +

Update the website and announce the release

+Follow the directions on SourceForge for creating a new "release" and +uploading the tarballs. +

+ +

+Basically, to upload the tarball files with: +
++rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/ + +

+ +

+Update the web site by copying the docs/ directory's files to +/home/users/b/br/brianp/mesa-www/htdocs/ with: +
++sftp USERNAME,mesa3d@web.sourceforge.net + +

+ +

+Make an announcement on the mailing lists: + +mesa-dev@lists.freedesktop.org, +mesa-users@lists.freedesktop.org +and +mesa-announce@lists.freedesktop.org +

+ + + + + -- cgit v1.2.3