-
Notifications
You must be signed in to change notification settings - Fork 1
/
INSTALL
148 lines (102 loc) · 4.14 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
Introduction
============
sysbuild uses the GNU Automake and GNU Autoconf utilities as its build
system. These are used only when building the package from the source
code tree. If you want to install sysbuild from a prebuilt package
provided by your operating system, you do not need to read this
document.
For the impatient:
$ ./configure
$ make
$ make check
Gain root privileges
# make install
Drop root privileges
$ make installcheck
Or alternatively, install as a regular user into your home directory:
$ ./configure --prefix ~/local
$ make
$ make check
$ make install
$ make installcheck
Dependencies
============
To build and use sysbuild successfully you need:
* shtk 1.6 or greater.
* pkg-config.
Optionally, if you want to build and run the tests (recommended), you
need:
* Kyua 0.6 or greater.
If you are building sysbuild from the code on the repository, you will
also need the following tools:
* GNU Autoconf.
* GNU Automake.
Regenerating the build system
=============================
This is not necessary if you are building from a formal release
distribution file.
On the other hand, if you are building sysbuild from code extracted from
the repository, you must first regenerate the files used by the build
system. You will also need to do this if you modify configure.ac,
Makefile.am or any of the other build system files. To do this, simply
run:
$ autoreconf -i -s
If shtk is installed in a different prefix than Autoconf, you will also
need to tell autoreconf where the shtk M4 macros are located. Otherwise,
the configure script will be incomplete and will show confusing syntax
errors mentioning, for example, SHTK_CHECK. To fix this, you have to
run autoreconf in the following manner, replacing '<shtk-prefix>' with
the appropriate path:
$ autoreconf -i -s -I <shtk-prefix>/share/aclocal
General build procedure
=======================
To build and install the source package, you must follow these steps:
1. Configure the sources to adapt to your operating system. This is
done using the 'configure' script located on the sources' top
directory, and it is usually invoked without arguments unless you
want to change the installation prefix. More details on this
procedure are given on a later section.
2. Build the sources to generate the binaries and scripts. Simply run
'make' on the sources' top directory after configuring them. No
problems should arise.
3. Install the library by running 'make install'. You may need to
become root to issue this step.
4. Issue any manual installation steps that may be required. These are
described later in their own section.
5. Check that the installed library works by running 'make
installcheck'. You do not need to be root to do this.
Configuration flags
===================
The most common, standard flags given to 'configure' are:
* --prefix=directory
Possible values: Any path
Default: /usr/local
Specifies where the library (scripts and all associated files) will
be installed.
* --sysconfdir=directory
Possible values: Any path
Default: /usr/local/etc
Specifies where the installed programs will look for configuration
files. '/sysbuild' will be appended to the given path unless
SYSBUILD_CONFSUBDIR is redefined as explained later on.
* --help
Shows information about all available flags and exits immediately,
without running any configuration tasks.
The following environment variables are specific to sysbuild's
'configure' script:
* SYSBUILD_CONFSUBDIR
Possible values: empty, a relative path.
Default: sysbuild.
Specifies the subdirectory of the configuration directory (given by
the --sysconfdir argument) under which sysbuild will search for its
configuration files.
Run the tests!
==============
Lastly, after a successful installation (and assuming you have Kyua
installed in your system), you should periodically run the tests
from the final location to ensure things remain stable. Do so as
follows:
$ kyua test -k /usr/local/tests/sysbuild/Kyuafile
And if you see any tests fail, do not hesitate to report them in:
https://github.com/jmmv/sysbuild/issues/
Thank you!