BUILD

   1 #
   2 #==================================================================================
   3 #       Copyright (c) 2019 Nokia
   4 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #==================================================================================
  18 #
  19
  20
  21 Building RMr
  22
  23 The RIC Message Router (RMr) is built with CMake, and requires
  24 a modern gcc compiler and make to be installed on the build
  25 system. Typically, installing the following list of packages
  26 in a container (Ubuntu) is all that is needed to craft a
  27 development environment (containerised builds are also the
  28 recommended approach):
  29
  30  gcc git make vim cmake g++ ksh bash
  31
  32 Kshell and vi are needed only if you wish to use the container
  33 interactively. Bash is assumed necessary for CMake.
  34
  35
  36 Build process
  37 To build RMr, the usual CMake steps are followed:
  38         mkdir build
  39         cd build
  40         cmake .. [options]
  41         make package
  42
  43
  44 This will create a .deb (provided the system supports this) in
  45 the build directory.  It's that simple.
  46
  47 Continuous Integration Build
  48 Use the Dockerfile in the ci/ subdirectory. This installs all
  49 the required tools, then builds RMr and executes the unit and
  50 programm tests. If tests pass, then  an image is created in the
  51 local registry with both run-time and development packages.
  52
  53 To support the distribution of package(s) created during the
  54 build by the CI process,  a YAML file is left in the /tmp
  55 directory (build_packages.yml) which contains a list of the
  56 packages available from the image.  Currently, both .deb and
  57 .rpm packages are generated.
  58
  59 The following is a sample YAML file generated during this process:
  60
  61    ---
  62    files:
  63      - /tmp/rmr-dev_1.0.34_x86_64.deb
  64      - /tmp/rmr-dev-1.0.34-x86_64.rpm
  65      - /tmp/rmr_1.0.34_x86_64.deb
  66      - /tmp/rmr-1.0.34-x86_64.rpm
  67    ...
  68
  69
  70
  71 Alternatives
  72 To build in a non-Linux environment, or to build with an
  73 alternate install path (or both) read on.
  74
  75 Instead of using 'make package' as listed above, using
  76 'make install'  will build and install on the local system.
  77 By default, the target install is into /usr/local which may
  78 not be desired.  To install into an alternate path add
  79 these two options when the 'cmake ..' command is given:
  80
  81   -DCMAKE_INSTALL_PREFIX=/path/to/dir
  82   -DMAN_PREFIX=/path/to/dir
  83
  84
  85 The first will cause the make process to install into the named
  86 directory, which can be in your home directory. The second
  87 defines where manual pages are placed (if not defined
  88 /usr/share/man is the target).   Manual pages are generally
  89 NOT built as the required tool has yet to be incorporated into
  90 the build process and generally is not available on most systems.
  91
  92
  93 Compiling and Linking User Applications
  94 Should the Rmr and NNG/Nano libraries be installed in a directory
  95 outside of the normal system spots (e.g. not in /usr/local)
  96 it might be necessary to define the specific directory for
  97 libraries (.e.g -L) on the command line, or via environment
  98 variables (e.g.. C_INCLUDE_PATH, LD_LIBRARY_PATH, LIBRARY_PATH).
  99 It may also be necessary to have the library directory defined
 100 in the environment at run time.  It is difficult to know what
 101 each system needs, but the following linker ooptions  work when
 102 libraries are installed in the system spots:
 103
 104         -lrmr_nng -lnng -lpthread
 105
 106 Adding -L is one way to compensate when libraries are installed
 107 a different spot (e.g. in $HOME/usr):
 108
 109         -L $HOME/usr -lrmr_nng -lnng -lpthread
 110
 111
 112 Libraries
 113 RMr supports both NNG and Nanomsg as underlying transport. They
 114 are separate beasts, and while an NNG based program can
 115 communicate with a Nanomsg based programme, their APIs are NOT
 116 compatible.  For this reason, and others, RMr generates two
 117 libraries and requires that the underlying transport be selected
 118 at link time rather than run time.  The RMr API for both underlying
 119 mechanisms is the same, so generating a NNG and Nanomsg version
 120 of a programme should require no extra work; other than adding
 121 a second link statement and giving it a different name.
 122
 123 Nanomsg is on its way out with respect to community support. RMr
 124 will continue to support Nanomsg for a short period of time, but
 125 new programmes should NOT use Nanomsg.
 126
 127
 128 Manual Pages
 129 By default the deb created does not include the manual pages. To
 130 enable their creation, and subsequent inclusion in the deb, add
 131 the following option to the cmake command:
 132
 133         -DBUILD_DOC=1
 134
 135 This will cause the {X}fm text formatting package to be fetched
 136 (github) and built at cmake time (must exist before building)
 137 and will trigger the generation of the man pages in both postscript
 138 and troff format.  The troff pages are placed into the deb and
 139 the postscript pages are left in the build directory for the
 140 developer to convert to PDF, or otherwise use.
 141
 142