[Bf-blender-cvs] [424100c] master: Update scons build documentation

Sergey Sharybin noreply at git.blender.org
Wed Jan 28 19:40:58 CET 2015


Commit: 424100cecbb202004e1687d5066b2c88e7a58f58
Author: Sergey Sharybin
Date:   Wed Jan 28 23:37:45 2015 +0500
Branches: master
https://developer.blender.org/rB424100cecbb202004e1687d5066b2c88e7a58f58

Update scons build documentation

  - fix dead blender.org link (build dependencies)
  - rewrite $BLENDERHOME/{config,tools}/* to $BLENDERHOME/build_files/scons/{config,tools}/*

Patch by David Creswick, thanks!

Reviewers: jesterking

Differential Revision: https://developer.blender.org/D798

===================================================================

M	build_files/scons/config/linux-config.py
M	doc/build_systems/scons-dev.txt
M	doc/build_systems/scons.txt

===================================================================

diff --git a/build_files/scons/config/linux-config.py b/build_files/scons/config/linux-config.py
index 7438aaa..455dd23 100644
--- a/build_files/scons/config/linux-config.py
+++ b/build_files/scons/config/linux-config.py
@@ -144,7 +144,7 @@ BF_REDCODE_LIB = ''
 BF_REDCODE_INC = '${BF_REDCODE}/../' #C files request "libredcode/format.h" which is in "#extern/libredcode/format.h", stupid but compiles for now.
 BF_REDCODE_LIBPATH='${BF_REDCODE}/lib'
 
-# Mesa Libs should go here if your using them as well....
+# Mesa Libs should go here if you're using them as well....
 WITH_BF_STATICOPENGL = False
 BF_OPENGL = '/usr'
 BF_OPENGL_INC = '${BF_OPENGL}/include'
diff --git a/doc/build_systems/scons-dev.txt b/doc/build_systems/scons-dev.txt
index ae2be2b..9ca072c 100644
--- a/doc/build_systems/scons-dev.txt
+++ b/doc/build_systems/scons-dev.txt
@@ -35,13 +35,14 @@
     defaults.
 
     Much of the actual functionality can be found in the python scripts
-    in the directory $BLENDERHOME/tools, with Blender.py defining the
-    bulk of the functionality. btools.py has some helper functions, and
-    bcolors.py is for the terminal colors. mstoolkit.py and crossmingw.py
-    are modules which set up SCons for the MS VC++ 2003 toolkit and
-    the cross-compile toolset for compiling Windows binaries on Linux
-    respectively. Note: the cross-compile doesn't work yet for Blender,
-    but is added in preparation for having it work in the distant future.
+    in the directory $BLENDERHOME/build_files/scons/tools, with
+    Blender.py defining the bulk of the functionality. btools.py has some
+    helper functions, and bcolors.py is for the terminal
+    colors. mstoolkit.py and crossmingw.py are modules which set up SCons
+    for the MS VC++ 2003 toolkit and the cross-compile toolset for
+    compiling Windows binaries on Linux respectively. Note: the
+    cross-compile doesn't work yet for Blender, but is added in
+    preparation for having it work in the distant future.
 
     BlenderEnvironment
     ------------------
diff --git a/doc/build_systems/scons.txt b/doc/build_systems/scons.txt
index cb88c56..e3438f1 100644
--- a/doc/build_systems/scons.txt
+++ b/doc/build_systems/scons.txt
@@ -29,9 +29,9 @@
     a scons-local installation, which can be found in the scons/ subdirectory.
     This document uses the scons-local installation for its examples.
 
-    Check from the page
-    http://www.blender.org/development/building-blender/getting-dependencies/
-    that you have all dependencies needed for building Blender. Note that for
+    For build instructions, including dependencies, consult the appropriate
+    section for your platform at
+    http://wiki.blender.org/index.php/Dev:Doc/Building_Blender. Note that for
     windows many of these dependencies already come in the lib/windows module
     from CVS.
 
@@ -53,12 +53,13 @@
     from the command-line is given, then all libraries and binaries to
     build are configured.
 
-    The build uses BF_BUILDDIR to build into and BF_INSTALLDIR to
-    finally copy all needed files to get a proper setup. The BF_DOCDIR is
-    used to generate Blender Python documentation files to. These
-    variables have default values for every platform in
-    $BLENDERHOME/config/(platform)-config.py. After the build successfully
-    completes, you can find everything you need in BF_INSTALLDIR.
+    The build uses BF_BUILDDIR to build into and BF_INSTALLDIR to finally copy
+    all needed files to get a proper setup. The BF_DOCDIR is used to generate
+    Blender Python documentation files to. These variables have default values
+    for every platform in
+    $BLENDERHOME/build_files/scons/config/(platform)-config.py. See the next
+    section of this document for how to customize these paths. After the build
+    successfully completes, you can find everything you need in BF_INSTALLDIR.
 
     If you want to create the installer package of Blender on Windows you'll
     need to install nullsoft scriptable install system from http://nsis.sf.net.
@@ -72,8 +73,8 @@
     ---------------------
 
     The default values for your platform can be found in the directory
-    $BLENDERHOME/config. Your platform specific defaults are in
-    (platform)-config.py, where platform is one of:
+    $BLENDERHOME/build_files/scons/config. Your platform specific defaults are
+    in (platform)-config.py, where platform is one of:
 
         - linux, for machines running Linux
         - win32-vc, for Windows machines, compiling with a Microsoft compiler
@@ -81,12 +82,13 @@
         - darwin, for OS X machines
         (TBD: add cygwin, solaris and freebsd support)
 
-    These files you will normally not change. If you need to override
-    a default value, make a file called  $BLENDERHOME/user-config.py, and copy
-    settings from the config/(platform)-config.py that you want to change. Don't
-    copy the entire file (unless explicitely stated in the configuration file),
-    because you may not get updated options you don't change yourself, which may
-    result in build errors.
+    These files you will normally not change. If you need to override a
+    default value, make a file called $BLENDERHOME/user-config.py, and copy
+    settings from the build_files/scons/config/(platform)-config.py that you
+    want to change. Don't copy the entire file (unless explicitly stated in
+    the configuration file), because you may not get updated options you don't
+    change yourself, which may result in build errors. You should NEVER have
+    to modify $BLENDERHOME/build_files/scons/config/(platform)-config.py.
 
     You can use BF_CONFIG argument to override the default user-config.py
     check. This is just like the user-config.py, but just with another name:
@@ -113,11 +115,6 @@
     (unless you have overridden any of them in your
     $BLENDERHOME/user-config.py).
 
-    NOTE: The best way to avoid confusion is the
-    copy $BLENDERHOME/config/(platform)-config.py to
-    $BLENDERHOME/user-config.py. You should NEVER have to modify
-    $BLENDERHOME/config/(platform)-config.py
-
     Configuring the output
     ----------------------




More information about the Bf-blender-cvs mailing list