README

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