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 or 0.12.x (you'll need not just the interpreter but nodejs-dev)
  15 * [CMake](http://cmake.org) 2.8.8+
  16
  17 For Debian-like distros the below command installs the basic set:
  18
  19 ```bash
  20 sudo apt-get install git build-essential swig3.0 python-dev nodejs-dev cmake
  21 ```
  22
  23 To build the documentation you'll also need:
  24 * [Doxygen](http://www.stack.nl/~dimitri/doxygen/) 1.8.9.1+
  25 * [Graphviz](http://graphviz.org/) 2+ (For doxygen graph generation)
  26 * [Sphinx](http://sphinx-doc.org/) 1.1.3+ (For Python docs)
  27
  28
  29 ## Basic build steps
  30
  31 ~~~~~~~~~~~~~{.sh}
  32 mkdir build
  33 cd build
  34 cmake ..
  35 make
  36 ~~~~~~~~~~~~~
  37
  38 If this goes wrong and you have all the dependencies installed, then please
  39 file an issue with the full output of `cmake ..` and `make` or however far you
  40 got.
  41
  42 After that you can install built files (into default path) by running:
  43
  44
  45 ```bash
  46 sudo make install
  47 ```
  48
  49 See flags for adjusting install paths in the section below.
  50
  51 Currently our install logic puts Python bindings into standard paths, which
  52 do not work on Debian due to their
  53  [policy](http://www.debian.org/doc/packaging-manuals/python-policy/ch-python.html#s-paths).
  54
  55 We are working on a permanent solution, in the meanwhile please use this command
  56 after `make install` to link installed modules where Debian's Python expects them:
  57
  58 ```bash
  59 sudo ln -s <your install prefix, e.g. /usr>/lib/python2.7/site-packages/* /usr/lib/python2.7/dist-packages
  60 ```
  61
  62 Same approach works for Python 3, you'll just need to adjust the version number
  63 in the path accordingly.
  64
  65 ## Configuration flags
  66
  67 Our cmake configure has a number of options, cmake-gui or ccmake (cmake -i is
  68 no longer with us :() can show you all the options. A few of the more common
  69 ones are listed below. Note that when the option starts with CMAKE_ it's an
  70 option that is made available by cmake and will be similar in all cmake
  71 projects. You need to add them after `cmake` but before `..`.
  72
  73 A few recommended options:
  74 Changing install path from /usr/local to /usr:
  75  -DCMAKE_INSTALL_PREFIX:PATH=/usr
  76
  77 Building debug build - adds -g and disables optimisations - this will force a
  78 full rebuild:
  79  -DCMAKE_BUILD_TYPE=DEBUG
  80
  81 Using clang instead of gcc:
  82  -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
  83
  84 Building with an older version of SWIG (< 3.0.2) requires the disabling of javascript:
  85  -DBUILDSWIGNODE=OFF
  86
  87 Disabling python module building:
  88  -DBUILDSWIGPYTHON=OFF
  89
  90 Building doc, this will require [SPHINX](http://sphinx-doc.org) &
  91 [Doxygen](http://doxygen.org):
  92  -DBUILDDOC=ON
  93
  94 Building with python3 (careful you need to clear cmake cache between python
  95 version switches!)
  96  -DBUILDPYTHON3=ON
  97
  98 Override build architecture (this is useful because on x86 arm code is not
  99 compiled so use this flag to force the target arch)
 100  -DBUILDARCH=arm
 101
 102 ## Dependencies continued
 103
 104 You'll need at least SWIG version 3.0.2 and we recommend 3.0.5 to build the
 105 javascript & python modules. If your version of SWIG is older than this then
 106 please see above for disabling SWIGNODE. Otherwise you will get a weird build
 107 failure when building the javascript module. The python module builds with SWIG
 108 2.x.
 109
 110 During the build, we'll assume you're building from git, note that if you
 111 compile with git installed your version of mraa will be tagged -dirty. This
 112 simply means git wasn't installed or that you where building form a tarball.
 113 You can modify build/src/version.c before running make if this is incorrect.
 114 The instructions listed here all assume that build/ is an empty dir that lives
 115 inside the cloned repository of mraa.
 116
 117 If you have multiple versions of python then mraa can get confused, we
 118 recommend using virtualenv to select which version of python you want. We test
 119 2.7 the most but SWIG will generate valid 3.x python code but we do not
 120 generally support building both at once.
 121
 122 ## Using a yocto/oe toolchain
 123
 124 In order to compile with a yocto/oe toolchain use the following toolchain file.
 125 This works well on the edison 1.6 SDK. First source the environment file, then
 126 use our cmake toolchain file.
 127
 128 ~~~~~~~~~~~~~{.sh}
 129 source /opt/poky-edison/1.6/environment-setup-core2-32-poky-linux
 130 mkdir build
 131 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/oe-sdk_cross.cmake ..
 132 make
 133 ~~~~~~~~~~~~~
 134
 135 ## Using coverity
 136
 137 Static analysis is routinely performed using coverity on libmraa's codebase.
 138 This is the procedure to submit a build to coverity. You'll need to install
 139 coverity-submit for your OS.
 140
 141 ~~~~~~~~~~~~~{.sh}
 142 mkdir covbuild/ && cd covbuild
 143 cmake -DBUILDDOC=OFF -DBUILDSWIG=OFF ..
 144 cov-build --dir cov-int make
 145 tar caf mraa.tar.bz2 cov-int
 146 ~~~~~~~~~~~~~
 147
 148 ## Building Java bindings
 149 Have JAVA_HOME set to JDK install directory. Most distributions set this from /etc/profile.d/ and have a way of switching between alternatives. We support both OpenJDK and Oracle's JDK. On Arch Linux with openjdk8 you'll have to set this yourself like this:
 150 ~~~~~~~~~~~~~{.sh}
 151 export JAVA_HOME=/usr/lib/jvm/default/
 152 ~~~~~~~~~~~~~
 153 Then use the cmake configuration flag:
 154  -DBUILDSWIGJAVA=ON
 155 To compile Example.java
 156 ~~~~~~~~~~~~~{.sh}
 157 javac -cp $DIR_WHERE_YOU_INSTALLED_MRAA/mraa.jar:. Example.java
 158 ~~~~~~~~~~~~~
 159 To run, make sure libmraajava.so is in LD_LIBRARY_PATH
 160  ~~~~~~~~~~~~~{.sh}
 161 jave -cp $DIR_WHERE_YOU_INSTALLED_MRAA/mraa.jar:. Example
 162 ~~~~~~~~~~~~~
 163
 164 ## Building an IPK/RPM package using cpack
 165
 166 You can get cpack to generate an IPK or RPM package fairly easily if you have
 167 the correct packaging tools
 168
 169 ~~~~~~~~~~~~~{.sh}
 170 cmake -DIPK=ON -DCMAKE_INSTAL_PREFIX=/usr ..
 171 make package
 172 ~~~~~~~~~~~~~
 173
 174 To use RPM simply enable the RPM option. You'll need rpmbuild installed on your
 175 build machine.
 176
 177 ~~~~~~~~~~~~~{.sh}
 178 cmake -DRPM=ON -DCMAKE_INSTAL_PREFIX=/usr ..
 179 ~~~~~~~~~~~~~