svn merge -r41779:41847 ^/trunk/blender
[blender.git] / GNUmakefile
1 # -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
2 # vim: tabstop=4
3 #
4 # ##### BEGIN GPL LICENSE BLOCK #####
5 #
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.
10 #
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.
15 #
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.
19 #
20 # ##### END GPL LICENSE BLOCK #####
21
22 # This Makefile does an out-of-source CMake build in ../build/`OS`_`CPU`
23 # eg:
24 #   ../build/Linux_i386
25 # This is for users who like to configure & build blender with a single command.
26
27
28 # System Vars
29 OS:=$(shell uname -s)
30 OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')
31 # CPU:=$(shell uname -m)  # UNUSED
32
33
34 # Source and Build DIR's
35 BLENDER_DIR:=$(shell pwd -P)
36 BUILD_TYPE:=Release
37
38 ifndef BUILD_CMAKE_ARGS
39         BUILD_CMAKE_ARGS:=
40 endif
41
42 ifndef BUILD_DIR
43         BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)
44 endif
45
46
47 # -----------------------------------------------------------------------------
48 # additional targets for the build configuration
49
50 # support 'make debug'
51 ifneq "$(findstring debug, $(MAKECMDGOALS))" ""
52         BUILD_DIR:=$(BUILD_DIR)_debug
53         BUILD_TYPE:=Debug
54 endif
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
58 endif
59 ifneq "$(findstring headless, $(MAKECMDGOALS))" ""
60         BUILD_DIR:=$(BUILD_DIR)_bpy
61         BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake
62 endif
63 ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
64         BUILD_DIR:=$(BUILD_DIR)_bpy
65         BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake
66 endif
67
68
69 # -----------------------------------------------------------------------------
70 # Get the number of cores for threaded build
71 NPROCS:=1
72 ifeq ($(OS), Linux)
73         NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)
74 endif
75 ifeq ($(OS), Darwin)
76         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3)
77 endif
78 ifeq ($(OS), FreeBSD)
79         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
80 endif
81 ifeq ($(OS), NetBSD)
82         NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
83 endif
84
85
86 # -----------------------------------------------------------------------------
87 # Macro for configuring cmake
88
89 CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
90                      -H$(BLENDER_DIR) \
91                      -B$(BUILD_DIR) \
92                      -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
93
94
95 # -----------------------------------------------------------------------------
96 # Build Blender
97 all:
98         @echo
99         @echo Configuring Blender ...
100
101         if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
102                 $(CMAKE_CONFIG); \
103         fi
104
105         @echo
106         @echo Building Blender ...
107         $(MAKE) -C $(BUILD_DIR) -s -j $(NPROCS) install
108         @echo
109         @echo edit build configuration with: "$(BUILD_DIR)/CMakeCache.txt" run make again to rebuild.
110         @echo blender installed, run from: "$(BUILD_DIR)/bin/blender"
111         @echo
112
113 debug: all
114 lite: all
115 headless: all
116 bpy: all
117
118 # -----------------------------------------------------------------------------
119 # Helo for build targets
120 help:
121         @echo ""
122         @echo "Convenience targets provided for building blender, (multiple at once can be used)"
123         @echo "  * debug     - build a debug binary"
124         @echo "  * lite      - disable non essential features for a smaller binary and faster build"
125         @echo "  * headless  - build without an interface (renderfarm or server automation)"
126         @echo "  * bpy       - build as a python module which can be loaded from python directly"
127         @echo ""
128         @echo "  Note, passing the argument 'BUILD_DIR=path' when calling make will override the default build dir."
129         @echo "  Note, passing the argument 'BUILD_CMAKE_ARGS=args' lets you add cmake arguments."
130         @echo ""
131         @echo ""
132         @echo "Project Files for IDE's"
133         @echo "  * project_qtcreator - QtCreator Project Files"
134         @echo "  * project_netbeans  - NetBeans Project Files"
135         @echo "  * project_eclipse   - Eclipse CDT4 Project Files"
136         @echo ""
137         @echo "Package Targets"
138         @echo "  * package_debian  - build a debian package"
139         @echo "  * package_pacman  - build an arch linux pacmanpackage"
140         @echo "  * package_archive - build an archive package"
141         @echo ""
142         @echo "Testing Targets (not assosiated with building blender)"
143         @echo "  * test            - run ctest, currently tests import/export, operator execution and that python modules load"
144         @echo "  * test_cmake      - runs our own cmake file checker which detects errors in the cmake file list definitions"
145         @echo "  * test_pep8       - checks all python script are pep8 which are tagged to use the stricter formatting"
146         @echo "  * test_deprecated - checks for deprecation tags in our code which may need to be removed"
147         @echo ""
148         @echo "Static Source Code Checking (not assosiated with building blender)"
149         @echo "  * check_cppcheck  - run blender source through cppcheck (C & C++)"
150         @echo "  * check_splint    - run blenders source through splint (C only)"
151         @echo "  * check_sparse    - run blenders source through sparse (C only)"
152         @echo ""
153         @echo "Documentation Targets (not assosiated with building blender)"
154         @echo "  * doc_py   - generate sphinx python api docs"
155         @echo "  * doc_doxy - generate doxygen C/C++ docs"
156         @echo "  * doc_dna  - generate blender file format reference"
157         @echo "  * doc_man  - generate manpage"
158         @echo ""
159
160 # -----------------------------------------------------------------------------
161 # Packages
162 #
163 package_debian:
164         cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
165
166 package_pacman:
167         cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg --asroot
168
169 package_archive:
170         make -C $(BUILD_DIR) -s package_archive
171         @echo archive in "$(BUILD_DIR)/release"
172
173
174 # -----------------------------------------------------------------------------
175 # Tests
176 #
177 test:
178         cd $(BUILD_DIR) ; ctest . --output-on-failure
179
180 # run pep8 check check on scripts we distribute.
181 test_pep8:
182         python3 source/tests/pep8.py > test_pep8.log 2>&1
183         @echo "written: test_pep8.log"
184
185 # run some checks on our cmakefiles.
186 test_cmake:
187         python3 build_files/cmake/cmake_consistency_check.py > test_cmake_consistency.log 2>&1
188         @echo "written: test_cmake_consistency.log"
189
190 # run deprecation tests, see if we have anything to remove.
191 test_deprecated:
192         python3 source/tests/check_deprecated.py
193
194
195 # -----------------------------------------------------------------------------
196 # Project Files
197 #
198
199 project_qtcreator:
200         python3 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
201
202 project_netbeans:
203         python3 build_files/cmake/cmake_netbeans_project.py $(BUILD_DIR)
204
205 project_eclipse:
206         cmake -G"Eclipse CDT4 - Unix Makefiles" -H$(BLENDER_DIR) -B$(BUILD_DIR)
207
208
209 # -----------------------------------------------------------------------------
210 # Static Checking
211 #
212
213 check_cppcheck:
214         $(CMAKE_CONFIG)
215         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py
216
217 check_splint:
218         $(CMAKE_CONFIG)
219         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py
220
221 check_sparse:
222         $(CMAKE_CONFIG)
223         cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
224
225
226 # -----------------------------------------------------------------------------
227 # Documentation
228 #
229
230 # Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
231 doc_py:
232         $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/python_api/sphinx_doc_gen.py
233         cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
234         @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
235
236 doc_doxy:
237         cd doc/doxygen; doxygen 
238         @echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
239
240 doc_dna:
241         $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python doc/blender_file_format/BlendFileDnaExporter_25.py
242         @echo "docs written into: '$(BLENDER_DIR)/doc/blender_file_format/dna.html'"
243
244 doc_man:
245         python3 doc/manpage/blender.1.py $(BUILD_DIR)/bin/blender
246
247
248 clean:
249         $(MAKE) -C $(BUILD_DIR) clean
250
251 .PHONY: all