svn merge ^/trunk/blender -r50156:50159
[blender.git] / GNUmakefile
index 4aaa77ee52df788ac4c9354c27e1f22dc9d0d9a7..f48ac5c2e413647b338e149630c92907d63b518f 100644 (file)
@@ -1,6 +1,5 @@
 # -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
-# vim: tabstop=8
-# $Id$
+# vim: tabstop=4
 #
 # ##### BEGIN GPL LICENSE BLOCK #####
 #
@@ -20,9 +19,9 @@
 #
 # ##### END GPL LICENSE BLOCK #####
 
-# This Makefile does an out-of-source CMake build in ../build/`OS`_`CPU`
+# This Makefile does an out-of-source CMake build in ../build_`OS`_`CPU`
 # eg:
-#   ../build/Linux_i386
+#   ../build_linux_i386
 # This is for users who like to configure & build blender with a single command.
 
 
@@ -34,9 +33,15 @@ OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')
 
 # Source and Build DIR's
 BLENDER_DIR:=$(shell pwd -P)
-BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)
 BUILD_TYPE:=Release
-BUILD_CMAKE_ARGS:=""
+
+ifndef BUILD_CMAKE_ARGS
+       BUILD_CMAKE_ARGS:=
+endif
+
+ifndef BUILD_DIR
+       BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build_$(OS_NCASE)
+endif
 
 
 # -----------------------------------------------------------------------------
@@ -79,7 +84,60 @@ endif
 
 
 # -----------------------------------------------------------------------------
-# Helo for build targets
+# Macro for configuring cmake
+
+CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
+                     -H$(BLENDER_DIR) \
+                     -B$(BUILD_DIR) \
+                     -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
+
+
+# -----------------------------------------------------------------------------
+# Tool for 'make config'
+
+# X11 spesific
+ifdef DISPLAY
+       CMAKE_CONFIG_TOOL = cmake-gui
+else 
+       CMAKE_CONFIG_TOOL = ccmake
+endif
+
+
+# -----------------------------------------------------------------------------
+# Build Blender
+all:
+       @echo
+       @echo Configuring Blender ...
+
+       # if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
+       #       $(CMAKE_CONFIG); \
+       # fi
+       
+       # do this always incase of failed initial build, could be smarter here...
+       $(CMAKE_CONFIG)
+
+       @echo
+       @echo Building Blender ...
+       $(MAKE) -C $(BUILD_DIR) -s -j $(NPROCS) install
+       @echo
+       @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
+       @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
+       @echo
+
+debug: all
+lite: all
+headless: all
+bpy: all
+
+
+# -----------------------------------------------------------------------------
+# Configuration (save some cd'ing around)
+config:
+       $(CMAKE_CONFIG_TOOL) $(BUILD_DIR)
+
+
+# -----------------------------------------------------------------------------
+# Help for build targets
 help:
        @echo ""
        @echo "Convenience targets provided for building blender, (multiple at once can be used)"
@@ -88,6 +146,12 @@ help:
        @echo "  * headless  - build without an interface (renderfarm or server automation)"
        @echo "  * bpy       - build as a python module which can be loaded from python directly"
        @echo ""
+       @echo "  * config    - run cmake configuration tool to set build options"
+       @echo ""
+       @echo "  Note, passing the argument 'BUILD_DIR=path' when calling make will override the default build dir."
+       @echo "  Note, passing the argument 'BUILD_CMAKE_ARGS=args' lets you add cmake arguments."
+       @echo ""
+       @echo ""
        @echo "Project Files for IDE's"
        @echo "  * project_qtcreator - QtCreator Project Files"
        @echo "  * project_netbeans  - NetBeans Project Files"
@@ -98,37 +162,26 @@ help:
        @echo "  * package_pacman  - build an arch linux pacmanpackage"
        @echo "  * package_archive - build an archive package"
        @echo ""
-       @echo "Testing Targets (not assosiated with building blender)"
+       @echo "Testing Targets (not associated with building blender)"
        @echo "  * test            - run ctest, currently tests import/export, operator execution and that python modules load"
        @echo "  * test_cmake      - runs our own cmake file checker which detects errors in the cmake file list definitions"
        @echo "  * test_pep8       - checks all python script are pep8 which are tagged to use the stricter formatting"
        @echo "  * test_deprecated - checks for deprecation tags in our code which may need to be removed"
+       @echo "  * test_style      - checks C/C++ conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo ""
+       @echo "Static Source Code Checking (not associated with building blender)"
+       @echo "  * check_cppcheck    - run blender source through cppcheck (C & C++)"
+       @echo "  * check_splint      - run blenders source through splint (C only)"
+       @echo "  * check_sparse      - run blenders source through sparse (C only)"
+       @echo "  * check_spelling_c  - check for spelling errors (C/C++ only)"
+       @echo "  * check_spelling_py - check for spelling errors (Python only)"
+       @echo ""
+       @echo "Documentation Targets (not associated with building blender)"
+       @echo "  * doc_py   - generate sphinx python api docs"
+       @echo "  * doc_doxy - generate doxygen C/C++ docs"
+       @echo "  * doc_dna  - generate blender file format reference"
+       @echo "  * doc_man  - generate manpage"
        @echo ""
-
-
-# -----------------------------------------------------------------------------
-# Build Blender
-all:
-       @echo
-       @echo Configuring Blender ...
-
-       if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
-               cmake $(BUILD_CMAKE_ARGS) -H$(BLENDER_DIR) -B$(BUILD_DIR) -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE); \
-       fi
-
-       @echo
-       @echo Building Blender ...
-       $(MAKE) -C $(BUILD_DIR) -s -j $(NPROCS) install
-       @echo
-       @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
-       @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
-       @echo
-
-debug: all
-lite: all
-headless: all
-bpy: all
-
 
 # -----------------------------------------------------------------------------
 # Packages
@@ -152,33 +205,80 @@ test:
 
 # run pep8 check check on scripts we distribute.
 test_pep8:
-       python3 source/tests/pep8.py > test_pep8.log 2>&1
+       python3.2 source/tests/pep8.py > test_pep8.log 2>&1
        @echo "written: test_pep8.log"
 
 # run some checks on our cmakefiles.
 test_cmake:
-       python3 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
+       python3.2 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
        @echo "written: test_cmake_consistency.log"
 
 # run deprecation tests, see if we have anything to remove.
 test_deprecated:
-       python3 source/tests/check_deprecated.py
+       python3.2 source/tests/check_deprecated.py
 
+test_style:
+       # run our own checks on C/C++ style
+       PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/check_style_c.py $(BLENDER_DIR)/source/blender $(BLENDER_DIR)/source/creator --no-length-check
 
 # -----------------------------------------------------------------------------
 # Project Files
 #
 
 project_qtcreator:
-       python3 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
+       python3.2 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
 
 project_netbeans:
-       python3 build_files/cmake/cmake_netbeans_project.py $(BUILD_DIR)
+       python3.2 build_files/cmake/cmake_netbeans_project.py $(BUILD_DIR)
 
 project_eclipse:
        cmake -G"Eclipse CDT4 - Unix Makefiles" -H$(BLENDER_DIR) -B$(BUILD_DIR)
 
 
+# -----------------------------------------------------------------------------
+# Static Checking
+#
+
+check_cppcheck:
+       $(CMAKE_CONFIG)
+       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py
+
+check_splint:
+       $(CMAKE_CONFIG)
+       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py
+
+check_sparse:
+       $(CMAKE_CONFIG)
+       cd $(BUILD_DIR) ; python3.2 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
+
+check_spelling_py:
+       cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/release/scripts
+
+check_spelling_c:
+       cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3.2 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/source
+
+# -----------------------------------------------------------------------------
+# Documentation
+#
+
+# Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
+doc_py:
+       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
+       cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
+       @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
+
+doc_doxy:
+       cd doc/doxygen; doxygen Doxyfile
+       @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
+
+doc_dna:
+       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
+       @echo "docs written into: '$(BLENDER_DIR)/doc/blender_file_format/dna.html'"
+
+doc_man:
+       python3.2 doc/manpage/blender.1.py $(BUILD_DIR)/bin/blender
+
+
 clean:
        $(MAKE) -C $(BUILD_DIR) clean