5416ae26265e9ee2b44f15b74cdf96ff31003f83
[profile/ivi/node-startup-controller.git] / 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 Instructions
20 ------------------
21
22 In order to build the boot manager, run the following:
23
24   gtkdocize &&
25   autoreconf -ivf &&
26   ./configure [options] &&
27   make
28
29 The following configure options are available apart from the standard
30 choices:
31
32   --enable-debug=<yes|no>:
33
34     Enables or disables debug builds. Enabling
35     debug will cause more compiler warnings to
36     be generated that are then treated as errors
37     and make the build fail. This is useful for
38     catching problems during development.
39
40     The default is "no".
41
42   --with-prioritised-luc-types=<comma-separated integers>:
43
44     Allows to define an ordered list of LUC types to be prioritised
45     during start-up.
46
47     The default is an empty list.
48
49 For more information about all available configure options, run:
50
51   ./configure --help
52
53
54 Install Instructions
55 --------------------
56
57 To install the boot manager after having built it, run:
58
59   make install
60
61
62 Testing Instructions
63 --------------------
64
65 To run any test suites shipped with the boot manager, run:
66
67   make check
68
69 There may also be some post-install tests that can only be performed
70 after installing the boot manager into the system. Those can be
71 executed with:
72
73   make installcheck