| ... |
... |
@@ -23,6 +23,38 @@ BuildElement - Abstract class for build elements |
|
23
|
23
|
The BuildElement class is a convenience element one can derive from for
|
|
24
|
24
|
implementing the most common case of element.
|
|
25
|
25
|
|
|
|
26
|
+Built-in functionality
|
|
|
27
|
+----------------------
|
|
|
28
|
+
|
|
|
29
|
+The BuildElement base class provides built in functionality that could be over ridden by the
|
|
|
30
|
+individual plugins.
|
|
|
31
|
+
|
|
|
32
|
+This section will give a brief summary of how some of the common features work, some of them or the variables they
|
|
|
33
|
+use will be further detailed in the following sections.
|
|
|
34
|
+
|
|
|
35
|
+* Location for running commands
|
|
|
36
|
+
|
|
|
37
|
+ The ``command-subdir`` variable sets where the build commands will be executed, if the directory dose not exist it
|
|
|
38
|
+ will be created, it is defined relative to the buildroot.
|
|
|
39
|
+
|
|
|
40
|
+* Location for configuring the project
|
|
|
41
|
+
|
|
|
42
|
+ The ``conf-root`` is defined by default as ``./`` and is the location that specific build element can use to look
|
|
|
43
|
+ for build configuration files, currently autotools and cmake use this.
|
|
|
44
|
+
|
|
|
45
|
+ The configuration commands are run in ``command-subdir`` and by default ``conf-root`` is ``./`` so if
|
|
|
46
|
+ ``conf-root`` is not set the configuration files in ``command-subdir`` will be used.
|
|
|
47
|
+
|
|
|
48
|
+ By setting ``source-directory`` to ``"%{build-root}/Source"`` and your source elements ``directory`` variable to
|
|
|
49
|
+ ``Source`` then the configuration files in the directory ``source-subdir`` with-in your Source will be used.
|
|
|
50
|
+ However the location where your configuration command will be run will still be wherever you set your
|
|
|
51
|
+ ``command-subdir`` to be.
|
|
|
52
|
+
|
|
|
53
|
+* Install Location
|
|
|
54
|
+
|
|
|
55
|
+ You should not change the ``install-root`` variable as it is a special writeable location in the sandbox but it is
|
|
|
56
|
+ useful when writing custom install instructions as it may need to be supplied as the ``DESTDIR``, please see the
|
|
|
57
|
+ cmake build element for example.
|
|
26
|
58
|
|
|
27
|
59
|
Abstract method implementations
|
|
28
|
60
|
-------------------------------
|
