From 10f2ad1663ca5b041a850305a442e8cbf84cefab Mon Sep 17 00:00:00 2001 From: Brecht Van Lommel Date: Tue, 26 Feb 2013 00:49:45 +0000 Subject: CMake: update cmake.txt documentation to remove some old information and link to the wiki for detailed cmake build setup instructions. --- doc/build_systems/cmake.txt | 82 +++++++++------------------------------------ 1 file changed, 16 insertions(+), 66 deletions(-) (limited to 'doc') diff --git a/doc/build_systems/cmake.txt b/doc/build_systems/cmake.txt index b7a6bd9871e..c46978df2fa 100644 --- a/doc/build_systems/cmake.txt +++ b/doc/build_systems/cmake.txt @@ -7,12 +7,9 @@ 1. Introduction 2. Obtaining CMake - 3. Obtaining Dependencies - 4. Deciding on a Build Environment - 5. Configuring the build for the first time - 6. Configuring the build after SVN updates - 7. Specify alternate Python library versions and locations - + 3. Building Blender + 4. Generic Setup + 5. Configuring the build after SVN updates 1. Introduction --------------- @@ -28,36 +25,17 @@ The website also contains some documentation on CMake usage but I found the man page alone pretty helpful. - 3. Obtaining Dependencies - ------------------------- - - Check from the page - http://www.blender.org/cms/Getting_Dependencies.135.0.html that you - have all dependencies needed for building Blender. Note that for - windows many of these dependencies already come in the lib/windows - module from SVN. - - 4. Deciding on a Build Environment - ---------------------------------- - - To build Blender with the CMake scripts you first need to decide which - build environment you feel comfortable with. This decision will also be - influenced by the platform you are developing on. The current implementation - have been successfully used to generate build files for the following - environments: + 3. Building Blender + ------------------- - 1. Microsoft Visual Studio 2008. There is a free version available - at http://http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express + Building Blender requires obtaining a compiler, library dependencies, + and correct setup depending on the system. For details on how to set + up a build on various operating systems, see the wiki documentation: - 2. Xcode on Mac OSX + http://wiki.blender.org/index.php/Dev:Doc/Building_Blender - 3. Unix Makefiles (On Linux and Mac OSX): CMake actually creates make - files which generates nicely color coded output and a percentage - progress indicator. - - - 5. Configuring the build for the first time - ------------------------------------------- + 4. Generic Setup + ---------------- CMake allows one to generate the build project files and binary objects outside the source tree which can be pretty handy in working and experimenting @@ -113,42 +91,14 @@ It is also possible to use the commandline of 'cmake' to override certain of these settings. - 6. Configuring the build after SVN updates + 5. Configuring the build after SVN updates ------------------------------------------ The $BLENDERBUILD directory maintains a file called CMakeCache.txt which remembers the initial run's settings for subsequent generation runs. After - every SVN update it may be a good idea to rerun the generation before building - Blender again. Just rerun the original 'cmake' run to do this, the settings - will be remembered. For the example above the following will do after every - 'svn up': - - % cmake -G Xcode $BLENDERSOURCE - - 7. Specify alternate Python library versions and locations - ---------------------------------------------------------- - - The commandline can be used to override detected/default settings, e.g: - - On Unix: - cmake -D PYTHON_LIBRARY=/usr/local/lib/python3.2/config/libpython3.2.so -D PYTHON_INCLUDE_DIR=/usr/local/include/python3.2 ../blender - On Macs: - cmake -D PYTHON_INCLUDE_DIRS=/System/Library/Frameworks/Python.framework/Versions/3.2/include/python3.2 -G Xcode ../blender - - Mote that this should only be needed once per build directory generation because it will keep the overrides in CMakeCache.txt for subsequent runs. - - - - To be continued... - - TODO's - ------ - - 1. Get CMake to create proper distribution directories for the various platforms - like scons does. - 2. Investigate the viability of using CPack to package installs automatically. - 3. Refine this document and write detailed developer's document. - 4. Make sure all options (ffmpeg, openexr, quicktime) has proper CMake support - on the various platforms. + SVN updates that contain changes to the build system, rebuilding Blender will + automatically invoke CMake to regenerate the CMakeCache.txt and other files + as needed. /Jacques Beaurain (jbinto) + -- cgit v1.2.3 From 748dd18de44e485b7f0f30c296ae4df048cc0e37 Mon Sep 17 00:00:00 2001 From: Dalai Felinto Date: Thu, 28 Feb 2013 05:18:47 +0000 Subject: rst doc update: adding a link to Joystick class from bge.logic.joysticks (so one can find more about the joystick class without having to search joystick) code untested by the way. Sorry but I can no longer build sphinx docs here. I will try to fix that later. --- doc/python_api/rst/bge.logic.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/python_api/rst/bge.logic.rst b/doc/python_api/rst/bge.logic.rst index 944b1ca06a0..27029914487 100644 --- a/doc/python_api/rst/bge.logic.rst +++ b/doc/python_api/rst/bge.logic.rst @@ -127,7 +127,7 @@ Variables .. data:: joysticks - A list of attached joysticks. The list size it he maximum number of supported joysticks. If no joystick is available for a given slot, the slot is set to None. + A list of attached :class:`~bge.types.SCA_PythonJoystick`s. The list size is the maximum number of supported joysticks. If no joystick is available for a given slot, the slot is set to None. ***************** General functions -- cgit v1.2.3