X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fdevinfo.html;h=0f1d5ac612b6698f53d05d60fc782cb3e0aa3691;hb=428bed3bded5426d621cbbb1c3161c8984f0779d;hp=5aad0fb1d7406de7d2dd5a0ca40954b021c18290;hpb=8bc788ea9e73ef4c355dfea80ac5070c6f81ac1c;p=mesa.git diff --git a/docs/devinfo.html b/docs/devinfo.html index 5aad0fb1d74..0f1d5ac612b 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -8,7 +8,7 @@
-

The Mesa 3D Graphics Library

+ The Mesa 3D Graphics Library
@@ -17,15 +17,20 @@

Development Notes

-

Adding Extentions

+ + +

Adding Extensions

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

-

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 -

- -

-Line width: the preferred width to fill comments and code in Mesa is 78 -columns. Exceptions are sometimes made for clarity (e.g. tabular data is -sometimes filled to a much larger width so that extraneous carriage returns -don't obscure the table). -

- -

-Brace example: -

-
-	if (condition) {
-	   foo;
-	}
-	else {
-	   bar;
-	}
-
-	switch (condition) {
-	case 0:
-	   foo();
-	   break;
-
-	case 1: {
-	   ...
-	   break;
-	}
-
-	default:
-	   ...
-	   break;
-	}
-
- -

-Here's the GNU indent command which will best approximate my preferred style: -(Note that it won't format switch statements in the preferred way) -

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

-Places that are not directly visible to the GL API should prefer the use -of bool, true, and -false over GLboolean, GL_TRUE, and -GL_FALSE. In C code, this may mean that -#include <stdbool.h> needs to be added. The -try_emit_* methods in src/mesa/program/ir_to_mesa.cpp and -src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples. -

- - -

Marking a commit as a candidate for a stable branch

- -

-If you want a commit to be applied to a stable branch, -you should add an appropriate note to the commit message. -

- -

-Here are some examples of such a note: -

- - - -

Cherry-picking candidates for a stable branch

- -

-Please use git cherry-pick -x <commit> for cherry-picking a commit -from master to a stable branch. -

- -

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

- -
-
SConstruct
-
Android.common.mk
-
PACKAGE_VERSION
-
configure.ac
-
AC_INIT
-
- -

-Create a docs/relnotes/x.y.z.html file. -The bin/bugzilla_mesa.sh and bin/shortlog_mesa.sh scripts can be used to -create the HTML-formatted lists of bugfixes and changes to include in the file. -Link the new docs/relnotes/x.y.z.html file into the main relnotes.html file. -

- -

-Update docs/index.html. -

- -

-Tag the files with the release name (in the form mesa-x.y) -with: git tag -s mesa-x.y -m "Mesa x.y Release" -Then: git push origin mesa-x.y -

- - -

Make the tarballs

-

-Make the distribution files. From inside the Mesa directory: -

-	./autogen.sh
-	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

-

-Make a new directory for the release on annarchy.freedesktop.org with: -
- -mkdir /srv/ftp.freedesktop.org/pub/mesa/x.y - -

- -

-Basically, to upload the tarball files with: -
- -rsync -avP -e ssh MesaLib-x.y.* USERNAME@annarchy.freedesktop.org:/srv/ftp.freedesktop.org/pub/mesa/x.y/ - -

- -

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