TODO: describe that this is only necessary if you have custom paths
TODO: update SCons snippets and provide where paths should be set (instead of where it is used)
Certain parts of the build scripts may need to be adjusted to specify the location of files on the host build platform. The SConstruct file defines a build environment that contains the path to the compiler(s) and the search paths for headers and libaries.
SCons defines it's own default PATH for finding executables. If any of the build tools are located outside of the default locations, either the absolute path must be provided in the build environment defined in the SConstruct file or the user_path=1 option must be used when running scons commands.
The SConstruct is organized to allow for targets to be built for different platforms based on the target option to the scons command. SCons uses the Environment data structure to set build parameters such as the compiler path, header search directories, libraries to link against, etc.
The getHOSTEnv function configures common parameters for a particular build host. This function should be used to set common tools, compile flags and directory paths, such as the path to the directory where the required libraries are installed. The SCons documentation lists the built-in variables that are used to construct the compilation commands.
def getLinuxEnv(baseEnv):
boost_incdir, boost_libdir = findBoostDirs(baseEnv)
env = baseEnv.Clone(
HOST_ARCH = platform.machine() + '-linux',
TOOLS_DIR = baseEnv['tools_prefix'], # tools_prefix can be passed as a command option
BOOST_BASE= baseEnv['boost_prefix'], # boost_prefix can be passed as a command option
...
CPPPATH=[
'#',
'$TOOLS_DIR/include',
boost_incdir,
],
# Linker flags
LIBPATH=[
'$TOOLS_DIR/lib',
boost_libdir,
],
)
# Compile actions for various intermediate languages
env['PROTOC'] = '/usr/local/bin/protoc'
...
return env
The get_TARGET_platform function specializes the configuration for a particular target platform. This may involve changing the compiler path and updating the compiler flags.
def get_raspi2_platform(env):
# compiler location
env['TOOLCHAIN_DIR'] = "/tools/armpi-linux/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian"
env['CXX'] = '$TOOLCHAIN_DIR/bin/arm-linux-gnueabihf-g++'
env['LINK'] = '$TOOLCHAIN_DIR/bin/arm-linux-gnueabihf-g++'
...
env['PLATFORM'] = 'armpi-linux'
While the paths to the compiler or directories containing headers and libraries may need to be changed, there are other variable definitions that are required by the build steps.
Manually overriding SConstruct variables
Certain variables, such as target can be specified on the scons command line. By default, scons prints a help message containing a list of all the variables and their default values. Some variables are used internally as part of the Dust build and release process.
$ scons
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets ...
default(["default"], [])
To build the AP Bridge software:
$ scons apbridge # build the AP Bridge for i386
$ scons apbridge target=armpi # build the AP Bridge for Raspberry Pi
$ scons apbridge_pkg # Create AP Bridge package for i386
$ scons apbridge_pkg target=armpi # Create AP Bridge package for Raspbery Pi
For internal use, to build an AP Bridge release:
$ scons apbridge_release
Options for building:
debug: Build with debug symbols
default: True
actual: True
opt: Build with optimization
default: False
actual: False
...