pass -noaudio when running blender for various utilities - doc-gen and tests.
[blender.git] / GNUmakefile
index 8446541cfae3db1af0f13f0e213dd7560ca197bc..c68c8684687259ce83f0f75985eb2dfb461a2693 100644 (file)
@@ -34,9 +34,12 @@ 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:=""
+BUILD_CMAKE_ARGS:=
+
+ifndef BUILD_DIR
+       BUILD_DIR:=$(shell dirname $(BLENDER_DIR))/build/$(OS_NCASE)
+endif
 
 
 # -----------------------------------------------------------------------------
@@ -77,6 +80,16 @@ 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:
@@ -84,7 +97,7 @@ all:
        @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); \
+               $(CMAKE_CONFIG); \
        fi
 
        @echo
@@ -110,6 +123,9 @@ 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 "  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"
@@ -120,12 +136,25 @@ help:
        @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
@@ -141,6 +170,16 @@ 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
 #
@@ -176,6 +215,41 @@ 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