1 # -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
4 # ##### BEGIN GPL LICENSE BLOCK #####
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License
8 # as published by the Free Software Foundation; either version 2
9 # of the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software Foundation,
18 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 # ##### END GPL LICENSE BLOCK #####
22 # This Makefile does an out-of-source CMake build in ../build_`OS`_`CPU`
25 # This is for users who like to configure & build blender with a single command.
30 OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')
31 # CPU:=$(shell uname -m) # UNUSED
34 # Source and Build DIR's
35 BLENDER_DIR:=$(shell pwd -P)
38 ifndef BUILD_CMAKE_ARGS
43 BUILD_DIR:=$(shell dirname "$(BLENDER_DIR)")/build_$(OS_NCASE)
47 # -----------------------------------------------------------------------------
48 # additional targets for the build configuration
50 # support 'make debug'
51 ifneq "$(findstring debug, $(MAKECMDGOALS))" ""
52 BUILD_DIR:=$(BUILD_DIR)_debug
55 ifneq "$(findstring lite, $(MAKECMDGOALS))" ""
56 BUILD_DIR:=$(BUILD_DIR)_lite
57 BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/blender_lite.cmake"
59 ifneq "$(findstring cycles, $(MAKECMDGOALS))" ""
60 BUILD_DIR:=$(BUILD_DIR)_cycles
61 BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/cycles_standalone.cmake"
63 ifneq "$(findstring headless, $(MAKECMDGOALS))" ""
64 BUILD_DIR:=$(BUILD_DIR)_bpy
65 BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake"
67 ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
68 BUILD_DIR:=$(BUILD_DIR)_bpy
69 BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C"$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake"
73 # -----------------------------------------------------------------------------
74 # Get the number of cores for threaded build
77 NPROCS:=$(shell nproc)
80 NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3)
83 NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
86 NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
90 # -----------------------------------------------------------------------------
91 # Macro for configuring cmake
93 CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
96 -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
99 # -----------------------------------------------------------------------------
100 # Tool for 'make config'
104 CMAKE_CONFIG_TOOL = cmake-gui
106 CMAKE_CONFIG_TOOL = ccmake
110 # -----------------------------------------------------------------------------
114 @echo Configuring Blender ...
116 # if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
120 # do this always incase of failed initial build, could be smarter here...
124 @echo Building Blender ...
125 $(MAKE) -C "$(BUILD_DIR)" -s -j $(NPROCS) install
127 @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
128 @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
138 # -----------------------------------------------------------------------------
139 # Configuration (save some cd'ing around)
141 $(CMAKE_CONFIG_TOOL) "$(BUILD_DIR)"
144 # -----------------------------------------------------------------------------
145 # Help for build targets
148 @echo "Convenience targets provided for building blender, (multiple at once can be used)"
149 @echo " * debug - build a debug binary"
150 @echo " * lite - disable non essential features for a smaller binary and faster build"
151 @echo " * headless - build without an interface (renderfarm or server automation)"
152 @echo " * cycles - build Cycles standalone only, without Blender"
153 @echo " * bpy - build as a python module which can be loaded from python directly"
155 @echo " * config - run cmake configuration tool to set build options"
157 @echo " Note, passing the argument 'BUILD_DIR=path' when calling make will override the default build dir."
158 @echo " Note, passing the argument 'BUILD_CMAKE_ARGS=args' lets you add cmake arguments."
161 @echo "Project Files for IDE's"
162 @echo " * project_qtcreator - QtCreator Project Files"
163 @echo " * project_netbeans - NetBeans Project Files"
164 @echo " * project_eclipse - Eclipse CDT4 Project Files"
166 @echo "Package Targets"
167 @echo " * package_debian - build a debian package"
168 @echo " * package_pacman - build an arch linux pacmanpackage"
169 @echo " * package_archive - build an archive package"
171 @echo "Testing Targets (not associated with building blender)"
172 @echo " * test - run ctest, currently tests import/export, operator execution and that python modules load"
173 @echo " * test_cmake - runs our own cmake file checker which detects errors in the cmake file list definitions"
174 @echo " * test_pep8 - checks all python script are pep8 which are tagged to use the stricter formatting"
175 @echo " * test_deprecated - checks for deprecation tags in our code which may need to be removed"
176 @echo " * test_style_c - checks C/C++ conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
177 @echo " * test_style_c_qtc - same as test_style but outputs QtCreator tasks format"
178 @echo " * test_style_osl - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
179 @echo " * test_style_osl_qtc - checks OpenShadingLanguage conforms with blenders style guide: http://wiki.blender.org/index.php/Dev:Doc/CodeStyle"
181 @echo "Static Source Code Checking (not associated with building blender)"
182 @echo " * check_cppcheck - run blender source through cppcheck (C & C++)"
183 @echo " * check_clang_array - run blender source through clang array checking script (C & C++)"
184 @echo " * check_splint - run blenders source through splint (C only)"
185 @echo " * check_sparse - run blenders source through sparse (C only)"
186 @echo " * check_smatch - run blenders source through smatch (C only)"
187 @echo " * check_spelling_c - check for spelling errors (C/C++ only)"
188 @echo " * check_spelling_c_qtc - same as check_spelling_c but outputs QtCreator tasks format"
189 @echo " * check_spelling_osl - check for spelling errors (OSL only)"
190 @echo " * check_spelling_py - check for spelling errors (Python only)"
191 @echo " * check_descriptions - check for duplicate/invalid descriptions"
193 @echo "Utilities (not associated with building blender)"
194 @echo " * icons - updates PNG icons from SVG files."
195 @echo " * tbz - create a compressed svn export 'blender_archive.tar.bz2'"
197 @echo "Documentation Targets (not associated with building blender)"
198 @echo " * doc_py - generate sphinx python api docs"
199 @echo " * doc_doxy - generate doxygen C/C++ docs"
200 @echo " * doc_dna - generate blender file format reference"
201 @echo " * doc_man - generate manpage"
204 # -----------------------------------------------------------------------------
208 cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
211 cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg --asroot
214 make -C "$(BUILD_DIR)" -s package_archive
215 @echo archive in "$(BUILD_DIR)/release"
218 # -----------------------------------------------------------------------------
222 cd $(BUILD_DIR) ; ctest . --output-on-failure
224 # run pep8 check check on scripts we distribute.
226 python3 source/tests/pep8.py > test_pep8.log 2>&1
227 @echo "written: test_pep8.log"
229 # run some checks on our cmakefiles.
231 python3 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
232 @echo "written: test_cmake_consistency.log"
234 # run deprecation tests, see if we have anything to remove.
236 python3 source/tests/check_deprecated.py
239 # run our own checks on C/C++ style
240 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" "$(BLENDER_DIR)/source/blender" "$(BLENDER_DIR)/source/creator" --no-length-check
243 # run our own checks on C/C++ style
245 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" "$(BLENDER_DIR)/source/blender" "$(BLENDER_DIR)/source/creator" --no-length-check > \
247 @echo "written: test_style.tasks"
251 # run our own checks on C/C++ style
252 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" "$(BLENDER_DIR)/intern/cycles/kernel/shaders" "$(BLENDER_DIR)/release/scripts/templates_osl"
256 # run our own checks on C/C++ style
258 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_style_c.py" "$(BLENDER_DIR)/intern/cycles/kernel/shaders" "$(BLENDER_DIR)/release/scripts/templates_osl" > \
260 @echo "written: test_style.tasks"
262 # -----------------------------------------------------------------------------
267 python3 build_files/cmake/cmake_qtcreator_project.py "$(BUILD_DIR)"
270 python3 build_files/cmake/cmake_netbeans_project.py "$(BUILD_DIR)"
273 cmake -G"Eclipse CDT4 - Unix Makefiles" -H"$(BLENDER_DIR)" -B"$(BUILD_DIR)"
276 # -----------------------------------------------------------------------------
282 cd "$(BUILD_DIR)" ; \
283 python3 "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py" 2> \
284 "$(BLENDER_DIR)/check_cppcheck.txt"
285 @echo "written: check_cppcheck.txt"
289 cd "$(BUILD_DIR)" ; \
290 python3 "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_clang_array.py"
294 cd "$(BUILD_DIR)" ; \
295 python3 "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py"
299 cd "$(BUILD_DIR)" ; \
300 python3 "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py"
304 cd "$(BUILD_DIR)" ; \
305 python3 "$(BLENDER_DIR)/build_files/cmake/cmake_static_check_smatch.py"
308 cd "$(BUILD_DIR)" ; \
309 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" "$(BLENDER_DIR)/release/scripts"
312 cd "$(BUILD_DIR)" ; \
313 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" "$(BLENDER_DIR)/source"
315 check_spelling_c_qtc:
316 cd "$(BUILD_DIR)" ; USE_QTC_TASK=1 \
317 PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" "$(BLENDER_DIR)/source" > \
318 "$(BLENDER_DIR)/check_spelling_c.tasks"
321 cd "$(BUILD_DIR)" ; PYTHONIOENCODING=utf_8 python3 "$(BLENDER_DIR)/source/tools/check_source/check_spelling.py" "$(BLENDER_DIR)/intern/cycles/kernel/shaders"
324 "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python "$(BLENDER_DIR)/source/tools/check_source/check_descriptions.py"
326 # -----------------------------------------------------------------------------
331 svn export . blender_archive
332 tar cjf blender_archive.tar.bz2 blender_archive/
333 rm -rf blender_archive/
334 @echo "blender_archive.tar.bz2 written"
337 "$(BLENDER_DIR)/release/datafiles/blender_icons_update.py"
338 "$(BLENDER_DIR)/release/datafiles/prvicons_update.py"
341 # -----------------------------------------------------------------------------
345 # Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
347 "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
348 cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
349 @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
352 cd doc/doxygen; doxygen Doxyfile
353 @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
356 "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
357 @echo "docs written into: '$(BLENDER_DIR)/doc/blender_file_format/dna.html'"
360 python3 doc/manpage/blender.1.py "$(BUILD_DIR)/bin/blender"
364 $(MAKE) -C "$(BUILD_DIR)" clean