5 |
5 |
6 #. ConE API (read, write) |
6 #. ConE API (read, write) |
7 #. ConE plugin API (A plugin interface to add functionality to ConE) |
7 #. ConE plugin API (A plugin interface to add functionality to ConE) |
8 #. ConE command line interface (tools/utilities that use the API) |
8 #. ConE command line interface (tools/utilities that use the API) |
9 |
9 |
10 ConE API |
10 ConE API introduction |
11 -------- |
11 --------------------- |
12 The ConE API tries to offer a simple way to access the configurations inside the Configuration |
12 The ConE API tries to offer a simple way to access the configurations inside the Configuration |
13 project. The concepts of confml and the Configuration project are quite complicated, but the API |
13 project. The concepts of confml and the Configuration project are quite complicated, but the API |
14 simplifies the project quite a bit to enable effective programming. Although the API aims for |
14 simplifies the project quite a bit to enable effective programming. Although the API aims for |
15 simplicity, everything is made available via the API. |
15 simplicity, everything is made available via the API. |
16 The API is described in this document with python api documentation tool *epydoc*. |
|
17 |
16 |
18 ConE plugin API |
17 The API is described in :ref:`cone-api` with a :ref:`cone-api-howto` and with python api documentation tool *epydoc*. |
19 --------------- |
18 |
|
19 ConE plugin (extension) API |
|
20 --------------------------- |
20 The purpose of the plugin API is to offer the possibility to expand the functionality of Configuration project. Normal use case |
21 The purpose of the plugin API is to offer the possibility to expand the functionality of Configuration project. Normal use case |
21 is an implementation plugin which reads data from the configuration and transforms it into some other form |
22 is an implementation plugin which reads data from the configuration and transforms it into some other form |
22 (e.g. centralrepository text file). |
23 (e.g. centralrepository text file). |
23 |
24 |
24 ConE command line interface |
25 See :ref:`plugin-api`. |
25 --------------------------- |
26 |
|
27 ConE command line interface introduction |
|
28 ---------------------------------------- |
26 The main purpose of ConE is to offer the above APIs, but ConE installation as tool |
29 The main purpose of ConE is to offer the above APIs, but ConE installation as tool |
27 offers also set of command line utilities that can used to modify, read and utilize (generate other output files |
30 offers also set of command line utilities that can used to modify, read and utilize (generate other output files |
28 with implementation plugins) from a Configuration project. These utilities lie on the cone-script package and |
31 with implementation plugins) from a Configuration project. These utilities lie on the cone-script package and |
29 are described in the ConE command line interface section. |
32 are described in the ConE command line interface section. |
|
33 |
|
34 See :ref:`cone-cli` |
30 |
35 |
31 Installation |
36 Installation |
32 ------------ |
37 ------------ |
33 |
38 |
34 Requirements |
39 Requirements |
98 Install from ZIP |
103 Install from ZIP |
99 ^^^^^^^^^^^^^^^^ |
104 ^^^^^^^^^^^^^^^^ |
100 |
105 |
101 Fetch the latest ConE build from our CruiseControl build server (works only in Nokia intranet): |
106 Fetch the latest ConE build from our CruiseControl build server (works only in Nokia intranet): |
102 |
107 |
103 * Goto http://trwec021.nmp.nokia.com:8080/buildresults/cone-build |
108 * Goto https://trace1.isource-nokia.nokia.com/trac/cone/wiki/ConeReleases |
104 * Click on the Build Artifacts to get the latest build. Older builds are also available for some time. |
109 * Download the release zip file from ConE releases. |
105 * Download the zip file |
|
106 |
110 |
107 The ZIP file should contain a pre-built standalone installation described in the previous section. |
111 The ZIP file should contain a pre-built standalone installation described in the previous section. |
108 Simply unzip it where you please. |
112 Simply unzip it where you please. |
109 |
113 |
110 |
114 |