diff options
author | Sergey Sharybin <sergey.vfx@gmail.com> | 2015-01-28 21:37:45 +0300 |
---|---|---|
committer | Sergey Sharybin <sergey.vfx@gmail.com> | 2015-01-28 21:40:41 +0300 |
commit | 424100cecbb202004e1687d5066b2c88e7a58f58 (patch) | |
tree | 273fbaacbc08bd947dfe8fadb60fa902b1b0ab44 /doc | |
parent | 66f85d34876b9b6fb77009bff94d9df618eaf9e4 (diff) |
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
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build_systems/scons-dev.txt | 15 | ||||
-rw-r--r-- | doc/build_systems/scons.txt | 41 |
2 files changed, 27 insertions, 29 deletions
diff --git a/doc/build_systems/scons-dev.txt b/doc/build_systems/scons-dev.txt index ae2be2b2a94..9ca072c38c5 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 cb88c56ddbc..e3438f1fe04 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 ---------------------- |