You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by pn...@apache.org on 2016/10/18 19:26:30 UTC
[28/50] [abbrv] celix git commit: CELIX-282: Update BUILDING text,
now refers to documents/building/readme.md
CELIX-282: Update BUILDING text, now refers to documents/building/readme.md
Project: http://git-wip-us.apache.org/repos/asf/celix/repo
Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/14ff7294
Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/14ff7294
Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/14ff7294
Branch: refs/heads/release/celix-2.0.0
Commit: 14ff72942af04e6f00c39c440ec3fd3b07a8817e
Parents: 5a8109d
Author: Pepijn Noltes <pe...@gmail.com>
Authored: Mon Oct 10 13:13:07 2016 +0200
Committer: Pepijn Noltes <pe...@gmail.com>
Committed: Mon Oct 10 13:13:07 2016 +0200
----------------------------------------------------------------------
BUILDING | 72 +++--------------------------------------------------------
1 file changed, 3 insertions(+), 69 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/celix/blob/14ff7294/BUILDING
----------------------------------------------------------------------
diff --git a/BUILDING b/BUILDING
index 819d42b..fb87152 100644
--- a/BUILDING
+++ b/BUILDING
@@ -10,73 +10,7 @@ Notes
* More information about the build system, and how to extend it, can be found at
the website: http://celix.apache.org/documentation.html
-
-Quick Start
------------
-
- # Create a build directory next to the celix source directory
- $ mkdir celix-build; cd celix-build
- $ ccmake ../celix
-
- # When this is the first time the CMake cache is created, a configuration has to be created
- # This is done by running Configure (c) in CMake.
-
- # Enable/Disable the required sub projects (BUILD_{NAME} entries)
- # Optionally, enable advanced mode (t) and change CMAKE_INSTALL_PREFIX
- # Run Configure (might be needed multiple times)
- # Run Generate (this also returns to the shell)
- $ make
-
- # To deploy the included examples
- $ make deploy
- # Navigate to <subproject>/deploy/<deployname>
- $ sh run.sh
-
- # To install the release (framework, headers and bundles)
- $ make install-all
-
- # To see a list of all available targets
- $ make help
-
-
-Unit testing using CppUTest
----------------------------
-
-Apache Celix has build options that enable a set of unit tests for each component. These tests
-are based on CppUTest, which needs to be installed separately.
-To run the tests
- $ make test
-To get a HTML page with the test coverage
- $ make coverage
-The coverage results are found in <build_dir>/coverage_results/index.html
-
-Background information
-----------------------
-
-Apache Celix uses CMake to generate the build files needed for compilation.
-deployment and installation.
+Building
+--------
-* CMake (http://www.cmake.org)
- CMake generated build files based on specific CMake files. To setup a build
- a console (ccmake) and GUI (cmake-gui) method is provided. With these editors
- include paths, installation prefix etc can be changed.
- CMake stores the configuration in a cache, which is used during the build.
- To keep the cache/build files separate from the source, a out-of-source build
- is preferred. To start from scratch, the build directory can be deleted and
- new build files can be generated.
-* Apache Celix Subprojects
- Since Apache Celix provides a modular framework, it makes sense to provide the
- available components as modules as well. To enable/disable these modules cmake
- is used. In the GUI or console there are settings named BUILD_{NAME} which can
- be switched on or off. On http://celix.apache.org/subprojects.html a
- list of all subprojects is given.
-* Apache Celix deployment/installation
- With a modular system it doesn't make sense to simply install everything to
- the file system. Depending on the needs different version/modules can be
- needed.
- To cater for this, Celix provides deployment support which takes care of
- copying the required bundles to a named target. A basic run script is
- created as well.
- Installing the framework (and its dependencies) might make sense, every target
- needs the framework. To install only the framework a dedicated target is
- available: make install-release.
+See documents/building/readme.md for howto build Apache Celix