X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fdevinfo.html;h=2d1c125e8029166c7042f325b140cab54eaca386;hb=9d20849516fe34bb0a430b007cef7878858cf0c7;hp=398637c51c5ad1c574eff9920f05bf78615935ae;hpb=9c27050e277e571c5ad9737ea2bd4fb828f7f7ef;p=mesa.git diff --git a/docs/devinfo.html b/docs/devinfo.html index 398637c51c5..2d1c125e802 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -2,7 +2,9 @@ Development Notes - + + +

Development Notes

@@ -10,29 +12,43 @@

Adding Extentions

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

-   If glext.h doesn't define the extension, 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 -

-

-In general, look for an extension similar to the new one that's already -implemented in Mesa and follow it by example. -

+To add a new GL extension to Mesa you have to do at least the following. + + @@ -71,7 +87,7 @@ Brace example: Here's the GNU indent command which will best approximate my preferred style:

-	indent -br -i3 -npcs infile.c -o outfile.c
+	indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
 
@@ -84,14 +100,14 @@ Constants and macros are ALL_UPPERCASE, with _ between words

-Global vars not allowed. +Global variables are not allowed.

Function name examples:

-	glFooBar()       - a public GL entry point (in dispatch.c)
+	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
@@ -99,133 +115,107 @@ Function name examples:
 
-

Writing a Device Driver

- -

-XXX to do -

- - -

Making a New Mesa Release

These are the instructions for making a new Mesa release.

+

Get latest source files

-Prerequisites (later versions may work): +Use git to get the latest Mesa files from the git repository, from whatever +branch is relevant.

- -

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

+

Verify and update version info

-Update the version strings in src/get.c and src/X/fakeglx.c to return -the new Mesa version number. +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.

-Create/edit the docs/RELNOTES-X-Y file to document what's new in the release. -Edit the docs/VERSIONS file too. +Update the MESA_MAJOR, MESA_MINOR and MESA_TINY version numbers in +configs/default. +Also update the VERSION line in the top-level Makefile.

-Edit Make-config and change the MESA_MAJOR and/or MESA_MINOR versions. +Make sure the values in src/mesa/main/version.h are correct.

-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.3)" in the configure.in file. +Update docs/news.html.

-Remove the leading `dnl' from the line "dnl AM_MAINTAINER_MODE". +Check in all updates to git.

-Verify the version numbers near the top of configure.in +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

-

-Run "fixam -f" to disable automatic dependency tracking. -

+

Make the tarballs

-Run the bootstrap script to generate the configure script. +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.

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

+Make the distribution files. From inside the Mesa directory: +
+	make tarballs
+

-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. +After the tarballs are created, the md5 checksums for the files will +be computed. +Add them to the docs/relnotes-X.Y.html file.

-Make a symbolic link from $(DIRECTORY) to Mesa. For example, -ln -s Mesa Mesa-3.3 This is needed in order to make a correct -tar file in the next step. +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

-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. +Follow the directions on SourceForge for creating a new "release" and +uploading the tarballs.

-Upload the *.tar.gz and *.zip files to ftp.mesa3d.org +Basically, to upload the tarball files with: +
+ +rsync -avP ssh Mesa*-X.Y.* USERNAME@frs.sourceforge.net:uploads/ +

-Update the web site. +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 + +mesa-dev@lists.freedesktop.org, +mesa-users@lists.freedesktop.org and -mesa3d-announce@lists.sf.net +mesa-announce@lists.freedesktop.org

-

Autoconf info

- -

-In order to run the bootstrap script you'll need: -

-

-autoconf 2.50
-automake 1.4-p5
-libtool 1.4
-
-