README

   1 GENIVI Node Startup Controller README
   2 =====================================
   3
   4 This is the official source repository of the GENIVI Node Startup
   5 Controller.
   6
   7 At present, all relevant documentation for this project is available
   8 in the GENIVI wiki on
   9
  10   https://collab.genivi.org/wiki/display/genivi/SysInfraEGLifecycleExecPrjctBootManager
  11
  12
  13 License
  14 -------
  15
  16 For licensing information, see the COPYING file distributed along with
  17 with this project.
  18
  19
  20 Build Dependencies
  21 ------------------
  22
  23 The following libraries need to be installed in order to be able to
  24 build the Node Startup Controller:
  25
  26   automotive-dlt >= 2.2.0
  27   gio-2.0 >= 2.30.0
  28   glib-2.0 >= 2.30.0
  29   gobject-2.0 >= 2.30.0
  30   libsystemd-daemon >= 183
  31
  32 In addition to this, and apart from the standard tools like autoreconf,
  33 automake and libtool, the following command-line utilities need to be
  34 available for building:
  35
  36   gdbus-codegen
  37   gtkdocize (and related GTK-Doc tools)
  38
  39
  40 Build Instructions
  41 ------------------
  42
  43 In order to build the Node Startup Controller, run the following:
  44
  45   (test -d m4 || mkdir m4) &&
  46   gtkdocize &&
  47   autoreconf -ivf &&
  48   ./configure [options] &&
  49   make
  50
  51 The following configure options are available apart from the standard
  52 choices:
  53
  54   --enable-debug=<yes|no>:
  55
  56     Enables or disables debug builds. Enabling
  57     debug will cause more compiler warnings to
  58     be generated that are then treated as errors
  59     and make the build fail. This is useful for
  60     catching problems during development.
  61
  62     The default is "no".
  63
  64   --with-prioritised-luc-types=<comma-separated integers>:
  65
  66     Allows to define an ordered list of LUC types to be prioritised
  67     during start-up.
  68
  69     The default is an empty list.
  70
  71 For more information about all available configure options, run:
  72
  73   ./configure --help
  74
  75
  76 Install Instructions
  77 --------------------
  78
  79 To install the Node Startup Controller after having built it, run:
  80
  81   make install
  82
  83
  84 Testing Instructions
  85 --------------------
  86
  87 To run any test suites shipped with the Node Startup Controller, run:
  88
  89   make check
  90
  91 There may also be some post-install tests that can only be performed
  92 after installing the Node Startup Controller into the system. Those
  93 can be executed with:
  94
  95   make installcheck