docs/building.md

   1 Building libmraa                         {#building}
   2 ===============
   3
   4 libmraa uses cmake in order to make compilation relatively painless. Cmake runs
   5 build out of tree so the recommended way is to clone from git and make a build/
   6 directory inside the clone directory.
   7
   8 ## Build dependencies
   9 Not all these are required but if you're unsure of what you're doing this is
  10 what you'll need:
  11 * [SWIG](http://swig.org) 3.0.5+
  12 * [git](http://git-scm.com)
  13 * [python](http://python.org) 2.7 or 3.4+ (you'll need not just the interpreter but python-dev)
  14 * [node.js](http://nodejs.org) 0.10.x (you'll need not just the interpreter but nodejs-dev)
  15 * [CMake](http://cmake.org) 2.8.8+
  16
  17 ## Basic build steps
  18
  19 ~~~~~~~~~~~~~{.sh}
  20 mkdir build
  21 cd build
  22 cmake ..
  23 make
  24 ~~~~~~~~~~~~~
  25
  26 If this goes wrong and you have all the dependencies installed, then please
  27 file an issue with the full output of `cmake ..` and `make` or however far you
  28 got.
  29
  30 ## Configuration flags
  31
  32 Our cmake configure has a number of options, cmake-gui or ccmake (cmake -i is
  33 no longer with us :() can show you all the options. A few of the more common
  34 ones are listed below. Note that when the option starts with CMAKE_ it's an
  35 option that is made available by cmake and will be similar in all cmake
  36 projects. You need to add them after `cmake` but before `..`.
  37
  38 A few recommended options:
  39 Changing install path from /usr/local to /usr:
  40  -DCMAKE_INSTALL_PREFIX:PATH=/usr
  41
  42 Building debug build - adds -g and disables optimisations - this will force a
  43 full rebuild:
  44  -DCMAKE_BUILD_TYPE=DEBUG
  45
  46 Using clang instead of gcc:
  47  -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
  48
  49 Building with an older version of SWIG (< 3.0.2) requires the disabling of javascript:
  50  -DBUILDSWIGNODE=OFF
  51
  52 Disabling python module building:
  53  -DBUILDSWIGPYTHON=OFF
  54
  55 Building doc, this will require [SPHINX](http://sphinx-doc.org) &
  56 [Doxygen](http://doxygen.org):
  57  -BUILDDOC=ON
  58
  59 ## Dependencies continued
  60
  61 You'll need at least SWIG version 3.0.2 and we recommend 3.0.5 to build the
  62 javascript & python modules. If your version of SWIG is older than this then
  63 please see above for disabling SWIGNODE. Otherwise you will get a weird build
  64 failure when building the javascript module. The python module builds with SWIG
  65 2.x.
  66
  67 During the build, we'll assume you're building from git, note that if you
  68 compile with git installed your version of mraa will be tagged -dirty. This
  69 simply means git wasn't installed or that you where building form a tarball.
  70 You can modify build/src/version.c before running make if this is incorrect.
  71 The instructions listed here all assume that build/ is an empty dir that lives
  72 inside the cloned repository of mraa.
  73
  74 If you have multiple versions of python then mraa can get confused, we
  75 recommend using virtualenv to select which version of python you want. We test
  76 2.7 the most but SWIG will generate valid 3.x python code but we do not
  77 generally support building both at once.
  78
  79 ## Using a yocto/oe toolchain
  80
  81 In order to compile with a yocto/oe toolchain use the following toolchain file.
  82 This works well on the edison 1.6 SDK. First source the environment file, then
  83 use our cmake toolchain file.
  84
  85 ~~~~~~~~~~~~~{.sh}
  86 source /opt/poky-edison/1.6/environment-setup-core2-32-poky-linux
  87 mkdir build
  88 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/oe-sdk_cross.cmake ..
  89 make
  90 ~~~~~~~~~~~~~
  91
  92 ## Using coverity
  93
  94 Static analysis is routinely performed using coverity on libmraa's codebase.
  95 This is the procedure to submit a build to coverity. You'll need to install
  96 coverity-submit for your OS.
  97
  98 ~~~~~~~~~~~~~{.sh}
  99 mkdir covbuild/ && cd covbuild
 100 cmake -DBUILDDOC=OFF -DBUILDSWIG=OFF ..
 101 cov-build --dir cov-int make
 102 tar caf mraa.tar.bz2 cov-int
 103 ~~~~~~~~~~~~~