Anonymous avatar Anonymous committed b943e15

Minor documentation fixes.

Comments (0)

Files changed (9)

 * freetype >= 2.3.5             (http://www.freetype.org)
 * portmidi >= 199               (http://portmedia.sourceforge.net/)
 * OpenAL                        use one of:
-  OpenAL11CoreSDK (Aug 2009)    http://www.openal.org 
-  openal-soft >= 1.11.753       http://kcat.strangesoft.net/openal.html
+    
+  * OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
+  * openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
 
 1.2 Notes on SVN usage
 ----------------------
 CRITICAL:
 =========
-* recheck and redesign X11 implementation for pygame.sdlext.scrap
 * make LayeredGroups class independent from sdl surfaces, where possible
 * check anything for possible integer/float overflows
-* use copy.copy and copy.deepcopy for consistent object copies
-* Rewrite and fix up numpysurfarray and numpysndarray
-* Add prebuilt package for Win32 VC++ builds.
 * Check display surface tracking for multiple calls to set_mode using
   different return variables.
 * Argument parsing must handle 64-bit conversions correctly.
 * Mark methods, which are limited to certain bpp ranges.
 * Add doc notes about quit() behaviour of the various modules.
 * add pgcompat.h to *mod.h internal headers.
-* Fix eval(repr(xyz)) for most types.
 * >8 bpp surfaces with palettes - it is supported (although it might be
   pointless) by SDL and so should we.
 
 * reorganise and add camera module
 * add movie module
 * subsurfaces via surface[x:y,a:b]? Brought up by ctgPi via IRC
+* Add prebuilt package for Win32 VC++ builds.
 
 Things to FIX:
 ==============
+* Fix eval(repr(xyz)) for most types.
+* use copy.copy and copy.deepcopy for consistent object copies
+* Rewrite and fix up numpysurfarray and numpysndarray
+* recheck and redesign X11 implementation for pygame.sdlext.scrap
 * check all string/unicode conversions, esp. file I/O with !UTF-8 and !ASCII
 * respect surface->clip_rect where necessary!
 * sdl.mouse.cursors, NOT pygame2.sdl.cursors or whatever

config/clangccompiler.py

 import distutils.sysconfig  as sysconfig
 
 class ClangCCompiler(UnixCCompiler):
-    """ClangCCompiler (verbose=0, dry_run=0, force=0) -> LLVMCCompiler
+    """ClangCCompiler (verbose=0, dry_run=0, force=0) -> ClangCCompiler
     
-    A simple compiler class for the clang frontent of the LLVM Compiler
+    A simple compiler class for the clang frontend of the LLVM Compiler
     infrastructure.
     """
     compiler_type = 'clang'
         UnixCCompiler.__init__ (self, verbose, dry_run, force)
         cc = 'clang'
 
-        cflags = sysconfig.get_config_var ('CFLAGS')
-        cshared = sysconfig.get_config_var ('CCSHARED')
-        ldflags = sysconfig.get_config_var ('LDFLAGS')
+        cflags = sysconfig.get_config_var ('CFLAGS') or ""
+        cshared = sysconfig.get_config_var ('CCSHARED') or ""
+        ldflags = sysconfig.get_config_var ('LDFLAGS') or ""
 
         self.set_executables(compiler=cc + ' ' + cflags,
                              compiler_so=cc + ' ' + cflags + ' ' + cshared,

doc/BuildDarwin.txt

 * freetype >= 2.3.5          (http://www.freetype.org)
 * portmidi >= 199            (http://portmedia.sourceforge.net/)
 * OpenAL                     use one of:
-  OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
-  openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
+    
+  * OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
+  * openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
 
 And you will need the dependency packages for the packages above:
 

doc/BuildMinGW.txt

 * freetype >= 2.3.5          (http://www.freetype.org)
 * portmidi >= 199            (http://portmedia.sourceforge.net/)
 * OpenAL                     use one of:
-  OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
-  openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
+    
+  * OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
+  * openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
 
 And you will need the dependency packages for the packages above:
 

doc/BuildUnix.txt

 Setting the environment
 -----------------------
 You will need a mostly C99 compatible compiler such as the GNU C
-Compiler and (optionally) a make utility such as GNU make or pmake.
+Compiler and (optionally) a make utility such as GNU make or pmake. A list of
+supported compilers can be found in the section :ref:`alternative-compilers`.
 
 Building the dependencies
 -------------------------
 * freetype >= 2.3.5          (http://www.freetype.org)
 * portmidi >= 199            (http://portmedia.sourceforge.net/)
 * OpenAL                     use one of:
-  OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
-  openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
+    
+  * OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
+  * openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
 
 And you will need the dependency packages for the packages above:
 
 
 for using the Makefile. This will try to perform a default installation
 with as many features as possible.
+
+.. _alternative-compilers:
+
+Using Alternative Compilers
+---------------------------
+Pygame2 offers support for using different compilers on Unix platforms. Those
+are
+
+* Intel C++ Compiler suite (http://software.intel.com/en-us/intel-compilers/)
+* GNU C Compiler (http://gcc.gnu.org)
+* LLVM Clang Compiler (http://clang.llvm.org/)
+
+The GNU C Compiler will be used as default compiler for most Unix platforms (or
+better: is installed as default compiler). To use a different compiler,
+execute ::
+
+  python setup.py build --compiler=icc
+  python setup.py build -c icc 			# same as above, but shorter
+  
+for the Intel C++ Compiler or ::
+
+  python setup.py build --compiler=clang
+  python setup.py build -c clang 		# same as above, but shorter
+ 
+for the LLVM Clang Compiler.
 * freetype >= 2.3.5          (http://www.freetype.org)
 * portmidi >= 199            (http://portmedia.sourceforge.net/)
 * OpenAL                     use one of:
-  OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
-  openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
+    
+  * OpenAL11CoreSDK (Aug 2009) http://www.openal.org 
+  * openal-soft >= 1.11.753    http://kcat.strangesoft.net/openal.html
 
 The Win32 build chain for Pygame2 does not support building all
 dependencies from scratch. Instead it relies on already built libraries,
 Create an new directory under src, using the name of the module you
 would like to create (see below, "Module naming"). All source files
 related to your module should go into that directory (and stay there!).
-You should use the Python 2.5 and 3.0 API for programming. In order to
+You should use the Python 2.5 and 3.1 API for programming. In order to
 support Python 2.4, include the "pgcompat.h" header file, where
 appropriate.
 
 will be replaced with the name and full path of the header file(s) to
 install.
 DOCFILE.xml is the name of the documentation file to use, which is located
-under doc/src (see below, "Documenting").
+under doc/src (see below, :ref:`documenting`).
 Each entry in the DEPENDENCYx list represents an external library reference
 which must be linked with the module. The names of these libraries can be
 found/modified in the config.config_modules file.
 typical python conventions. The files should be named all lowercase and
 be placed under lib.
 
+.. _documenting:
+
 Documenting
 -----------
 As written above (see "C module build system"), the documentation files

doc/src/examples.rst

 +------------------------------------+----------------------------------------+
 | pygame2.examples.sdlgfx.primitives | Demonstrates the features of the       |
 |                                    | :class:`pygame2.sdlgfx.primitives`     |
-|                                    | module.                                 |
+|                                    | module.                                |
 +------------------------------------+----------------------------------------+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.