Cleanup: manually remove header text not handled by automation
[blender.git] / GNUmakefile
index 8d251cb20ee4e5e6c498e8ed6dde478495caa887..d31abe66f37334b6b73482d99b2c92b0897d3cd1 100644 (file)
@@ -1,4 +1,4 @@
-# -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
+# -*- mode: gnumakefile; tab-width: 4; indent-tabs-mode: t; -*-
 # vim: tabstop=4
 #
 # ##### BEGIN GPL LICENSE BLOCK #####
@@ -43,6 +43,16 @@ ifndef BUILD_DIR
        BUILD_DIR:=$(shell dirname "$(BLENDER_DIR)")/build_$(OS_NCASE)
 endif
 
+# Dependencies DIR's
+DEPS_SOURCE_DIR:=$(BLENDER_DIR)/build_files/build_environment
+DEPS_BUILD_DIR:=$(BUILD_DIR)/deps
+DEPS_INSTALL_DIR:=$(shell dirname "$(BLENDER_DIR)")/lib/$(OS_NCASE)
+
+ifneq ($(OS_NCASE),darwin)
+       # Add processor type to directory name
+       DEPS_INSTALL_DIR:=$(DEPS_INSTALL_DIR)_$(shell uname -p)
+endif
+
 # Allow to use alternative binary (pypy3, etc)
 ifndef PYTHON
        PYTHON:=python3
@@ -79,6 +89,16 @@ ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
 endif
 
 
+# -----------------------------------------------------------------------------
+# Blender binary path
+
+ifeq ($(OS), Darwin)
+       BLENDER_BIN="$(BUILD_DIR)/bin/blender.app/Contents/MacOS/blender"
+else
+       BLENDER_BIN="$(BUILD_DIR)/bin/blender"
+endif
+
+
 # -----------------------------------------------------------------------------
 # Get the number of cores for threaded build
 ifndef NPROCS
@@ -86,14 +106,8 @@ ifndef NPROCS
        ifeq ($(OS), Linux)
                NPROCS:=$(shell nproc)
        endif
-       ifeq ($(OS), Darwin)
-               NPROCS:=$(shell sysctl -a | grep "hw.ncpu" | cut -d" " -f3)
-       endif
-       ifeq ($(OS), FreeBSD)
-               NPROCS:=$(shell sysctl -a | grep "hw.ncpu" | cut -d" " -f2 )
-       endif
-       ifeq ($(OS), NetBSD)
-               NPROCS:=$(shell sysctl -a | grep "hw.ncpu" | cut -d" " -f2 )
+       ifneq (,$(filter $(OS),Darwin FreeBSD NetBSD))
+               NPROCS:=$(shell sysctl -n hw.ncpu)
        endif
 endif
 
@@ -104,7 +118,7 @@ endif
 CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
                      -H"$(BLENDER_DIR)" \
                      -B"$(BUILD_DIR)" \
-                     -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
+                     -DCMAKE_BUILD_TYPE_INIT:STRING=$(BUILD_TYPE)
 
 
 # -----------------------------------------------------------------------------
@@ -113,30 +127,30 @@ CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
 # X11 spesific
 ifdef DISPLAY
        CMAKE_CONFIG_TOOL = cmake-gui
-else 
+else
        CMAKE_CONFIG_TOOL = ccmake
 endif
 
 
 # -----------------------------------------------------------------------------
 # Build Blender
-all: FORCE
+all: .FORCE
        @echo
-       @echo Configuring Blender ...
+       @echo Configuring Blender in \"$(BUILD_DIR)\" ...
 
-       # 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)
+#      # 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 Blender successfully built, run from: $(BLENDER_BIN)
        @echo
 
 debug: all
@@ -146,16 +160,37 @@ cycles: all
 headless: all
 bpy: all
 
+# -----------------------------------------------------------------------------
+# Build dependencies
+DEPS_TARGET = install
+ifneq "$(findstring clean, $(MAKECMDGOALS))" ""
+       DEPS_TARGET = clean
+endif
+
+deps: .FORCE
+       @echo
+       @echo Configuring dependencies in \"$(DEPS_BUILD_DIR)\"
+
+       @cmake -H"$(DEPS_SOURCE_DIR)" \
+              -B"$(DEPS_BUILD_DIR)" \
+                  -DHARVEST_TARGET=$(DEPS_INSTALL_DIR)
+
+       @echo
+       @echo Building dependencies ...
+       $(MAKE) -C "$(DEPS_BUILD_DIR)" -s -j $(NPROCS) $(DEPS_TARGET)
+       @echo
+       @echo Dependencies successfully built and installed to $(DEPS_INSTALL_DIR).
+       @echo
 
 # -----------------------------------------------------------------------------
 # Configuration (save some cd'ing around)
-config: FORCE
+config: .FORCE
        $(CMAKE_CONFIG_TOOL) "$(BUILD_DIR)"
 
 
 # -----------------------------------------------------------------------------
 # Help for build targets
-help: FORCE
+help: .FORCE
        @echo ""
        @echo "Convenience targets provided for building blender, (multiple at once can be used)"
        @echo "  * debug     - build a debug binary"
@@ -164,6 +199,7 @@ help: FORCE
        @echo "  * headless  - build without an interface (renderfarm or server automation)"
        @echo "  * cycles    - build Cycles standalone only, without Blender"
        @echo "  * bpy       - build as a python module which can be loaded from python directly"
+       @echo "  * deps      - build library dependencies (intended only for platform maintainers)"
        @echo ""
        @echo "  * config    - run cmake configuration tool to set build options"
        @echo ""
@@ -182,14 +218,20 @@ help: FORCE
        @echo "  * package_archive - build an archive package"
        @echo ""
        @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               - run ctest, currently tests import/export,"
+       @echo "                         operator execution and that python modules load"
+       @echo "  * test_cmake         - runs our own cmake file checker"
+       @echo "                         which detects errors in the cmake file list definitions"
+       @echo "  * test_pep8          - checks all python script are pep8"
+       @echo "                         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_c       - checks C/C++ conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test_style_c       - checks C/C++ conforms with blenders style guide:"
+       @echo "                         http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
        @echo "  * test_style_c_qtc   - same as test_style but outputs QtCreator tasks format"
-       @echo "  * test_style_osl     - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
-       @echo "  * test_style_osl_qtc - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test_style_osl     - checks OpenShadingLanguage conforms with blenders style guide:"
+       @echo "                         http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
+       @echo "  * test_style_osl_qtc - checks OpenShadingLanguage conforms with blenders style guide:"
+       @echo "                         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++)"
@@ -204,7 +246,9 @@ help: FORCE
        @echo "  * check_descriptions   - check for duplicate/invalid descriptions"
        @echo ""
        @echo "Utilities (not associated with building blender)"
-       @echo "  * icons    - updates PNG icons from SVG files."
+       @echo "  * icons    - Updates PNG icons from SVG files."
+       @echo "               Set environment variables 'BLENDER_BIN' and 'INKSCAPE_BIN'"
+       @echo "               to define your own commands."
        @echo "  * tgz      - create a compressed archive of the source code."
        @echo "  * update   - updates git and all submodules"
        @echo ""
@@ -228,13 +272,13 @@ help: FORCE
 # -----------------------------------------------------------------------------
 # Packages
 #
-package_debian: FORCE
+package_debian: .FORCE
        cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
 
-package_pacman: FORCE
+package_pacman: .FORCE
        cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg
 
-package_archive: FORCE
+package_archive: .FORCE
        make -C "$(BUILD_DIR)" -s package_archive
        @echo archive in "$(BUILD_DIR)/release"
 
@@ -242,24 +286,24 @@ package_archive: FORCE
 # -----------------------------------------------------------------------------
 # Tests
 #
-test: FORCE
+test: .FORCE
        cd $(BUILD_DIR) ; ctest . --output-on-failure
 
 # run pep8 check check on scripts we distribute.
-test_pep8: FORCE
+test_pep8: .FORCE
        $(PYTHON) tests/python/pep8.py > test_pep8.log 2>&1
        @echo "written: test_pep8.log"
 
 # run some checks on our cmakefiles.
-test_cmake: FORCE
+test_cmake: .FORCE
        $(PYTHON) 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: FORCE
+test_deprecated: .FORCE
        $(PYTHON) tests/check_deprecated.py
 
-test_style_c: FORCE
+test_style_c: .FORCE
        # run our own checks on C/C++ style
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
@@ -267,7 +311,7 @@ test_style_c: FORCE
            "$(BLENDER_DIR)/source/creator" \
            --no-length-check
 
-test_style_c_qtc: FORCE
+test_style_c_qtc: .FORCE
        # run our own checks on C/C++ style
        USE_QTC_TASK=1 \
        PYTHONIOENCODING=utf_8 $(PYTHON) \
@@ -280,7 +324,7 @@ test_style_c_qtc: FORCE
        @echo "written: test_style.tasks"
 
 
-test_style_osl: FORCE
+test_style_osl: .FORCE
        # run our own checks on C/C++ style
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" \
@@ -288,7 +332,7 @@ test_style_osl: FORCE
            "$(BLENDER_DIR)/release/scripts/templates_osl"
 
 
-test_style_osl_qtc: FORCE
+test_style_osl_qtc: .FORCE
        # run our own checks on C/C++ style
        USE_QTC_TASK=1 \
        PYTHONIOENCODING=utf_8 $(PYTHON) \
@@ -303,13 +347,13 @@ test_style_osl_qtc: FORCE
 # Project Files
 #
 
-project_qtcreator: FORCE
+project_qtcreator: .FORCE
        $(PYTHON) build_files/cmake/cmake_qtcreator_project.py "$(BUILD_DIR)"
 
-project_netbeans: FORCE
+project_netbeans: .FORCE
        $(PYTHON) build_files/cmake/cmake_netbeans_project.py "$(BUILD_DIR)"
 
-project_eclipse: FORCE
+project_eclipse: .FORCE
        cmake -G"Eclipse CDT4 - Unix Makefiles" -H"$(BLENDER_DIR)" -B"$(BUILD_DIR)"
 
 
@@ -317,40 +361,40 @@ project_eclipse: FORCE
 # Static Checking
 #
 
-check_cppcheck: FORCE
+check_cppcheck: .FORCE
        $(CMAKE_CONFIG)
        cd "$(BUILD_DIR)" ; \
        $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py" 2> \
            "$(BLENDER_DIR)/check_cppcheck.txt"
        @echo "written: check_cppcheck.txt"
 
-check_clang_array: FORCE
+check_clang_array: .FORCE
        $(CMAKE_CONFIG)
        cd "$(BUILD_DIR)" ; \
        $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_clang_array.py"
 
-check_splint: FORCE
+check_splint: .FORCE
        $(CMAKE_CONFIG)
        cd "$(BUILD_DIR)" ; \
        $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py"
 
-check_sparse: FORCE
+check_sparse: .FORCE
        $(CMAKE_CONFIG)
        cd "$(BUILD_DIR)" ; \
        $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py"
 
-check_smatch: FORCE
+check_smatch: .FORCE
        $(CMAKE_CONFIG)
        cd "$(BUILD_DIR)" ; \
        $(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_smatch.py"
 
-check_spelling_py: FORCE
+check_spelling_py: .FORCE
        cd "$(BUILD_DIR)" ; \
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
            "$(BLENDER_DIR)/release/scripts"
 
-check_spelling_c: FORCE
+check_spelling_c: .FORCE
        cd "$(BUILD_DIR)" ; \
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
@@ -359,7 +403,7 @@ check_spelling_c: FORCE
            "$(BLENDER_DIR)/intern/guardedalloc" \
            "$(BLENDER_DIR)/intern/ghost" \
 
-check_spelling_c_qtc: FORCE
+check_spelling_c_qtc: .FORCE
        cd "$(BUILD_DIR)" ; USE_QTC_TASK=1 \
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
@@ -370,33 +414,40 @@ check_spelling_c_qtc: FORCE
            > \
            "$(BLENDER_DIR)/check_spelling_c.tasks"
 
-check_spelling_osl: FORCE
+check_spelling_osl: .FORCE
        cd "$(BUILD_DIR)" ;\
        PYTHONIOENCODING=utf_8 $(PYTHON) \
            "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" \
            "$(BLENDER_DIR)/intern/cycles/kernel/shaders"
 
-check_descriptions: FORCE
-       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python \
+check_descriptions: .FORCE
+       $(BLENDER_BIN) --background -noaudio --factory-startup --python \
            "$(BLENDER_DIR)/source/tools/check_source/check_descriptions.py"
 
 # -----------------------------------------------------------------------------
 # Utilities
 #
 
-tgz: FORCE
+tgz: .FORCE
        ./build_files/utils/build_tgz.sh
 
-icons: FORCE
+icons: .FORCE
        "$(BLENDER_DIR)/release/datafiles/blender_icons_update.py"
        "$(BLENDER_DIR)/release/datafiles/prvicons_update.py"
 
-update: FORCE
+update: .FORCE
+       if [ "$(OS_NCASE)" = "darwin" ] && [ ! -d "../lib/$(OS_NCASE)" ]; then \
+               svn checkout https://svn.blender.org/svnroot/bf-blender/trunk/lib/$(OS_NCASE) ../lib/$(OS_NCASE) ; \
+       fi
        if [ -d "../lib" ]; then \
+               svn cleanup ../lib/* ; \
                svn update ../lib/* ; \
        fi
        git pull --rebase
-       git submodule foreach git pull --rebase origin master
+       git submodule update --init --recursive
+       # Use blender2.7 branch for submodules that have it.
+       git submodule foreach "git checkout blender2.7 || git checkout master"
+       git submodule foreach git pull --rebase origin
 
 
 # -----------------------------------------------------------------------------
@@ -404,36 +455,31 @@ update: FORCE
 #
 
 # Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
-doc_py: FORCE
-       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
+doc_py: .FORCE
+       ASAN_OPTIONS=halt_on_error=0 \
+       $(BLENDER_BIN) --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: FORCE
+doc_doxy: .FORCE
        cd doc/doxygen; doxygen Doxyfile
        @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
 
-doc_dna: FORCE
-       "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
+doc_dna: .FORCE
+       $(BLENDER_BIN) --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: FORCE
-       $(PYTHON) doc/manpage/blender.1.py "$(BUILD_DIR)/bin/blender"
-
-help_features: FORCE
-       @$(PYTHON) -c \
-               "import re; \
-               print('\n'.join([ \
-               w for l in open('"$(BLENDER_DIR)"/CMakeLists.txt', 'r').readlines() \
-               if not l.lstrip().startswith('#') \
-               for w in (re.sub(\
-                   r'.*\boption\s*\(\s*(WITH_[a-zA-Z0-9_]+)\s+(\".*\")\s*.*', r'\g<1> - \g<2>', l).strip('() \n'),) \
-               if w.startswith('WITH_')]))" | uniq
+doc_man: .FORCE
+       $(PYTHON) doc/manpage/blender.1.py $(BLENDER_BIN) blender.1
 
+help_features: .FORCE
+       @$(PYTHON) "$(BLENDER_DIR)/build_files/cmake/cmake_print_build_options.py" $(BLENDER_DIR)"/CMakeLists.txt"
 
-clean: FORCE
+clean: .FORCE
        $(MAKE) -C "$(BUILD_DIR)" clean
 
 .PHONY: all
 
-FORCE:
+.FORCE: