pass -noaudio when running blender for various utilities - doc-gen and tests.
[blender.git] / GNUmakefile
index 2dfbeb1336a67aeb321f3779bd8b911c6e5c5c06..c68c8684687259ce83f0f75985eb2dfb461a2693 100644 (file)
-# -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-\r
-# vim: tabstop=8\r
-# $Id: GNUmakefile 34680 2011-02-07 05:05:41Z campbellbarton $\r
-#\r
-# ##### BEGIN GPL LICENSE BLOCK #####\r
-#\r
-#  This program is free software; you can redistribute it and/or\r
-#  modify it under the terms of the GNU General Public License\r
-#  as published by the Free Software Foundation; either version 2\r
-#  of the License, or (at your option) any later version.\r
-#\r
-#  This program is distributed in the hope that it will be useful,\r
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-#  GNU General Public License for more details.\r
-#\r
-#  You should have received a copy of the GNU General Public License\r
-#  along with this program; if not, write to the Free Software Foundation,\r
-#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.\r
-#\r
-# ##### END GPL LICENSE BLOCK #####\r
-\r
-# This Makefile does an out-of-source CMake build in ../build/`OS`_`CPU`\r
-# eg:\r
-#   ../build/Linux_i386\r
-# This is for users who like to configure & build blender with a single command.\r
-\r
-\r
-# System Vars\r
-OS:=$(shell uname -s)\r
-OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')\r
-# CPU:=$(shell uname -m)  # UNUSED\r
-\r
-\r
-# Source and Build DIR's\r
-BLENDER_DIR:=$(shell pwd -P)\r
-BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)\r
-\r
-\r
-# Get the number of cores for threaded build\r
-NPROCS:=1\r
-ifeq ($(OS), Linux)\r
-       NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)\r
-endif\r
-ifeq ($(OS), Darwin)\r
-       NPROCS:=$(shell system_profiler | awk '/Number Of CPUs/{print $4}{next;}')\r
-endif\r
-ifeq ($(OS), FreeBSD)\r
-       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )\r
-endif\r
-ifeq ($(OS), NetBSD)\r
-       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )\r
-endif\r
-\r
-\r
-# Build Blender\r
-all:\r
-       @echo \r
-       @echo Configuring Blender ...\r
-\r
-       if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \\r
-               mkdir -p $(BUILD_DIR) ; \\r
-               cd $(BUILD_DIR) ; \\r
-               cmake $(BLENDER_DIR) -DCMAKE_BUILD_TYPE:STRING=Release ; \\r
-       fi\r
-\r
-       @echo \r
-       @echo Building Blender ...\r
-       cd $(BUILD_DIR) ; make -s -j $(NPROCS)\r
-       @echo \r
-       @echo run blender from "$(BUILD_DIR)/bin/blender"\r
-       @echo \r
-\r
-.PHONY: all\r
+# -*- mode: gnumakefile; tab-width: 8; indent-tabs-mode: t; -*-
+# vim: tabstop=8
+# $Id$
+#
+# ##### BEGIN GPL LICENSE BLOCK #####
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 2
+#  of the License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software Foundation,
+#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# This Makefile does an out-of-source CMake build in ../build/`OS`_`CPU`
+# eg:
+#   ../build/Linux_i386
+# This is for users who like to configure & build blender with a single command.
+
+
+# System Vars
+OS:=$(shell uname -s)
+OS_NCASE:=$(shell uname -s | tr '[A-Z]' '[a-z]')
+# CPU:=$(shell uname -m)  # UNUSED
+
+
+# Source and Build DIR's
+BLENDER_DIR:=$(shell pwd -P)
+BUILD_TYPE:=Release
+BUILD_CMAKE_ARGS:=
+
+ifndef BUILD_DIR
+       BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)
+endif
+
+
+# -----------------------------------------------------------------------------
+# additional targets for the build configuration
+
+# support 'make debug'
+ifneq "$(findstring debug, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_debug
+       BUILD_TYPE:=Debug
+endif
+ifneq "$(findstring lite, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_lite
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_lite.cmake
+endif
+ifneq "$(findstring headless, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_bpy
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/blender_headless.cmake
+endif
+ifneq "$(findstring bpy, $(MAKECMDGOALS))" ""
+       BUILD_DIR:=$(BUILD_DIR)_bpy
+       BUILD_CMAKE_ARGS:=$(BUILD_CMAKE_ARGS) -C$(BLENDER_DIR)/build_files/cmake/config/bpy_module.cmake
+endif
+
+
+# -----------------------------------------------------------------------------
+# Get the number of cores for threaded build
+NPROCS:=1
+ifeq ($(OS), Linux)
+       NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)
+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" " -f3 )
+endif
+ifeq ($(OS), NetBSD)
+       NPROCS:=$(shell sysctl -a | grep "hw.ncpu " | cut -d" " -f3 )
+endif
+
+
+# -----------------------------------------------------------------------------
+# Macro for configuring cmake
+
+CMAKE_CONFIG = cmake $(BUILD_CMAKE_ARGS) \
+                     -H$(BLENDER_DIR) \
+                     -B$(BUILD_DIR) \
+                     -DCMAKE_BUILD_TYPE:STRING=$(BUILD_TYPE)
+
+
+# -----------------------------------------------------------------------------
+# Build Blender
+all:
+       @echo
+       @echo Configuring Blender ...
+
+       if test ! -f $(BUILD_DIR)/CMakeCache.txt ; then \
+               $(CMAKE_CONFIG); \
+       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
+
+# -----------------------------------------------------------------------------
+# Helo for build targets
+help:
+       @echo ""
+       @echo "Convenience targets provided for building blender, (multiple at once can be used)"
+       @echo "  * debug     - build a debug binary"
+       @echo "  * lite      - disable non essential features for a smaller binary and faster build"
+       @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 "  Note, passing the argument 'BUILD_DIR=path' when calling make will override the default build dir."
+       @echo ""
+       @echo ""
+       @echo "Project Files for IDE's"
+       @echo "  * project_qtcreator - QtCreator Project Files"
+       @echo "  * project_netbeans  - NetBeans Project Files"
+       @echo "  * project_eclipse   - Eclipse CDT4 Project Files"
+       @echo ""
+       @echo "Package Targets"
+       @echo "  * package_debian  - build a debian package"
+       @echo "  * package_pacman  - build an arch linux pacmanpackage"
+       @echo "  * package_archive - build an archive package"
+       @echo ""
+       @echo "Other Targets (not assosiated with building blender)"
+       @echo "  * translations  - update blenders translation files in po/"
+       @echo ""
+       @echo "Testing Targets (not assosiated 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 ""
+       @echo "Static Source Code Checking (not assosiated 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 ""
+       @echo "Documentation Targets (not assosiated with building blender)"
+       @echo "  * doc_py   - generate sphinx python api docs"
+       @echo "  * doc_dna  - generate blender file format reference"
+       @echo "  * doc_man  - generate manpage"
+       @echo ""
+
+# -----------------------------------------------------------------------------
+# Packages
+#
+package_debian:
+       cd build_files/package_spec ; DEB_BUILD_OPTIONS="parallel=$(NPROCS)" sh ./build_debian.sh
+
+package_pacman:
+       cd build_files/package_spec/pacman ; MAKEFLAGS="-j$(NPROCS)" makepkg --asroot
+
+package_archive:
+       make -C $(BUILD_DIR) -s package_archive
+       @echo archive in "$(BUILD_DIR)/release"
+
+
+# -----------------------------------------------------------------------------
+# Other Targets
+#
+translations:
+       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python po/update_msg.py
+       python3 po/update_pot.py
+       python3 po/update_po.py
+       python3 po/update_mo.py
+
+
+# -----------------------------------------------------------------------------
+# Tests
+#
+test:
+       cd $(BUILD_DIR) ; ctest . --output-on-failure
+
+# run pep8 check check on scripts we distribute.
+test_pep8:
+       python3 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
+       @echo "written: test_cmake_consistency.log"
+
+# run deprecation tests, see if we have anything to remove.
+test_deprecated:
+       python3 source/tests/check_deprecated.py
+
+
+# -----------------------------------------------------------------------------
+# Project Files
+#
+
+project_qtcreator:
+       python3 build_files/cmake/cmake_qtcreator_project.py $(BUILD_DIR)
+
+project_netbeans:
+       python3 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 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_cppcheck.py
+
+check_splint:
+       $(CMAKE_CONFIG)
+       cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_splint.py
+
+check_sparse:
+       $(CMAKE_CONFIG)
+       cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
+
+
+# -----------------------------------------------------------------------------
+# 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 -n -b html sphinx-in sphinx-out
+       @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.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 doc/manpage/blender.1.py $(BUILD_DIR)/bin/blender
+
+
+clean:
+       $(MAKE) -C $(BUILD_DIR) clean
+
+.PHONY: all