You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by rl...@apache.org on 2020/02/03 14:47:27 UTC
[celix-site] branch master updated: Added documentation for 2.2.0
release to website
This is an automated email from the ASF dual-hosted git repository.
rlenferink pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/celix-site.git
The following commit(s) were added to refs/heads/master by this push:
new 6d0706c Added documentation for 2.2.0 release to website
6d0706c is described below
commit 6d0706cc0147563bbbac61fb5ec3031dafe3eb74
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Mon Feb 3 15:43:09 2020 +0100
Added documentation for 2.2.0 release to website
The 'Edit on GitHub' button will not be shown for older releases since it may have been changed already in version control.
---
NOTICE | 2 +-
README.md | 2 +-
celix-src | 2 +-
config.toml | 7 +-
extract_celix_docs.sh | 59 ++-
layouts/_default/baseof.html | 9 +-
layouts/celix-doc/baseof.html | 20 +-
layouts/index.html | 2 +-
layouts/partials/header.html | 19 +-
source/contributing/source-and-builds.md | 69 +++
source/contributing/submitting-patches.md | 4 +-
source/contributing/volunteers.md | 8 +-
source/docs/{ => 2.1.0}/celix/CHANGES.md | 3 +-
source/docs/{ => 2.1.0}/celix/README.md | 1 +
.../docs/{ => 2.1.0}/celix/config_admin/readme.md | 3 +-
.../{ => 2.1.0}/celix/dependency_manager/readme.md | 3 +-
.../celix/dependency_manager_cxx/readme.md | 3 +-
.../{ => 2.1.0}/celix/deployment_admin/README.md | 3 +-
.../docs/{ => 2.1.0}/celix/device_access/README.md | 3 +-
.../{ => 2.1.0}/celix/documents/building/readme.md | 3 +-
.../celix/documents/cmake_commands/readme.md | 3 +-
.../getting_started/creating_a_simple_bundle.md | 3 +-
.../celix/documents/getting_started/readme.md | 3 +-
.../getting_started/using_services_with_c.md | 3 +-
.../getting_started/using_services_with_cxx.md | 3 +-
.../{ => 2.1.0}/celix/documents/intro/readme.md | 3 +-
.../celix/documents/roadmap/api_v3/readme.md | 3 +-
.../celix/documents/roadmap/improvement_ideas.md | 3 +-
.../{ => 2.1.0}/celix/documents/roadmap/roadmap.md | 3 +-
.../celix/documents/subprojects/readme.md | 3 +-
source/docs/{ => 2.1.0}/celix/etcdlib/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/launcher/README.md | 3 +-
.../docs/{ => 2.1.0}/celix/log_service/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/log_writer/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/pubsub/README.md | 3 +-
.../celix/pubsub/examples/keys/README.md | 3 +-
.../celix/pubsub/pubsub_admin_udp_mc/README.md | 3 +-
.../{ => 2.1.0}/celix/remote_services/README.md | 5 +-
.../celix/remote_services/discovery_etcd/README.md | 3 +-
.../remote_services/remote_service_admin/README.md | 3 +-
.../remote_services/topology_manager/README.md | 3 +-
.../docs/{ => 2.1.0}/celix/remote_shell/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/shell/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/shell_tui/README.md | 3 +-
source/docs/{ => 2.1.0}/celix/utils/README.md | 3 +-
.../{ => 2.1.0}/celix/utils/docs/thpool/Design.md | 3 +-
.../{ => 2.1.0}/celix/utils/docs/thpool/FAQ.md | 3 +-
.../{ => 2.1.0}/celix/utils/docs/thpool/README.md | 3 +-
.../celix/utils/public/include/memstream/README.md | 3 +-
source/docs/2.1.0/docs.md | 25 +
source/docs/2.2.0/celix/CHANGES.md | 282 +++++++++++
source/docs/{ => 2.2.0}/celix/README.md | 9 +-
.../celix/bundles}/deployment_admin/README.md | 23 +-
.../celix/bundles}/device_access/README.md | 16 +-
.../device_access/example/base_driver}/README.md | 19 +-
.../example/consuming_driver}/README.md | 19 +-
.../example/refining_driver}/README.md | 16 +-
.../docs/2.2.0/celix/bundles/http_admin/README.md | 57 +++
.../celix/bundles/logging/log_service/README.md | 25 +
.../celix/bundles/logging/log_writer/README.md | 19 +
.../celix/bundles}/pubsub/README.md | 13 +-
.../celix/bundles}/pubsub/examples/keys/README.md | 4 +-
.../bundles}/pubsub/pubsub_admin_udp_mc/README.md | 13 +-
.../celix/bundles}/remote_services/README.md | 29 +-
.../remote_services/discovery_etcd/README.md | 15 +-
.../remote_service_admin_dfi/README.md | 39 ++
.../remote_services/remote_services_api}/README.md | 26 +-
.../bundles/remote_services/rsa_spi}/README.md | 26 +-
.../remote_services/topology_manager/README.md | 3 +-
.../celix/bundles/shell}/remote_shell/README.md | 3 +-
.../celix/bundles/shell}/shell/README.md | 15 +-
.../celix/bundles/shell}/shell_tui/README.md | 10 +-
.../celix/bundles/shell/shell_wui}/README.md | 18 +-
.../celix/documents/building/README.md} | 35 +-
.../2.2.0/celix/documents/cmake_commands/README.md | 513 +++++++++++++++++++++
.../celix/documents/getting_started/README.md} | 8 +-
.../getting_started/creating_a_simple_bundle.md | 133 ++----
.../getting_started/using_services_with_c.md | 7 +-
.../getting_started/using_services_with_cxx.md | 75 ++-
.../celix/documents/intro/README.md} | 19 +-
.../2.2.0/celix/documents/subprojects/README.md | 42 ++
.../celix/examples/celix-examples}/README.md | 13 +-
.../celix-examples/http_example}/README.md | 22 +-
.../celix-examples/services_example_c/README.md | 89 ++++
.../celix/libs/dependency_manager/README.md} | 26 +-
.../celix/libs/dependency_manager/TODO.md} | 14 +-
.../celix/libs/dependency_manager_cxx/README.md} | 15 +-
.../celix/libs/dependency_manager_cxx/TODO.md} | 14 +-
.../{celix => 2.2.0/celix/libs}/etcdlib/README.md | 6 +-
.../{celix => 2.2.0/celix/libs}/launcher/README.md | 27 +-
.../{celix => 2.2.0/celix/libs}/utils/README.md | 6 +-
.../celix/libs}/utils/docs/thpool/Design.md | 3 +-
.../celix/libs}/utils/docs/thpool/FAQ.md | 9 +-
.../celix/libs}/utils/docs/thpool/README.md | 3 +-
.../celix/libs/utils}/include/memstream/README.md | 3 +-
.../celix/misc/experimental}/README.md | 12 +-
.../experimental/bundles/config_admin/README.md} | 7 +-
source/docs/2.2.0/docs.md | 21 +
source/docs/docs.md | 22 -
source/support/issue-tracking.md | 16 +-
source/support/mailing-list.md | 5 +-
101 files changed, 1734 insertions(+), 469 deletions(-)
diff --git a/NOTICE b/NOTICE
index c7ea979..05694da 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1,5 +1,5 @@
Apache Celix
- Copyright 2018 The Apache Software Foundation
+ Copyright 2020 The Apache Software Foundation
================================================================================
diff --git a/README.md b/README.md
index c778073..3060d33 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,7 @@ See [Hugo](https://gohugo.io/) for more info and for details how to install Hugo
- Run `git submodule init` and `git submodule update` to retrieve the Celix sources.
- Run `./extract_celix_docs.sh` to copy the markdown files from the Celix main repository to the site repository.
-### Create doxygen documentation
+### Create Doxygen documentation
TODO
diff --git a/celix-src b/celix-src
index 353ac0d..85ef063 160000
--- a/celix-src
+++ b/celix-src
@@ -1 +1 @@
-Subproject commit 353ac0d2e0f819f8f59d4cdf8ea1dfd701201d74
+Subproject commit 85ef063a38758bdbe4aba1e6124a4d5d437a07be
diff --git a/config.toml b/config.toml
index bb152b0..41000a7 100644
--- a/config.toml
+++ b/config.toml
@@ -1,4 +1,4 @@
-baseURL = "http://celix.apache.org"
+baseURL = "https://celix.apache.org"
title = "Apache Celix"
languageCode = "en"
@@ -22,6 +22,9 @@ pygmentsStyle = "emacs"
# Enable Git variables like commit, lastmod
enableGitInfo = true
+[markup.goldmark.renderer]
+unsafe= true
+
[blackfriday]
# hrefTargetBlank = true # We don't want everything opened in a new window
fractions = false
@@ -30,6 +33,8 @@ fractions = false
date = ["date", ":filename", "publishDate", "lastmod"]
[params]
+latestVersion = "2.2.0"
+
repositoryUrl = "https://github.com/apache/celix"
repositorySourceBranch = "develop"
diff --git a/extract_celix_docs.sh b/extract_celix_docs.sh
index f873f25..b7736db 100644
--- a/extract_celix_docs.sh
+++ b/extract_celix_docs.sh
@@ -18,28 +18,49 @@
# A script to extract all markdown files from the Celix main repository
# and copies them to the path specified in ${site_doc_dir}
-CELIX_SRC_DIR=celix-src
-CELIX_DOC_DIR=source/docs/celix
+CELIX_SRC_DIR="celix-src"
+DOCS_DIR="source/docs"
-rm -rf ${CELIX_DOC_DIR}/*
+RELEASE_VERSION=${1}
+if [[ -z ${RELEASE_VERSION} ]]; then
+ echo "Celix release not specified!"
+ echo ""
+ echo "Run with:"
+ echo " ./extract_celix_docs.sh <released version>"
+ echo " e.g."
+ echo " ./extract_celix_docs.sh \"2.1.0\""
-for FILE_PATH in $(cd ${CELIX_SRC_DIR}; find . -name \*.md); do
- # Retrieve file information
- FILE_DIR="$(dirname ${FILE_PATH})"
- FILE_NAME="$(basename ${FILE_PATH})"
+ exit 1
+fi
- # Copy markdown file to site destination
- mkdir -p ${CELIX_DOC_DIR}/${FILE_DIR}
- cp -v ${CELIX_SRC_DIR}/${FILE_PATH} ${CELIX_DOC_DIR}/${FILE_DIR}
+RELEASE_DIR="${DOCS_DIR}/${RELEASE_VERSION}"
- # Prepend markdown file with Hugo header
- DEST_FILE=${CELIX_DOC_DIR}/${FILE_PATH}
- SECOND_LINE=$(head -n 2 ${DEST_FILE} | tail -n 1)
+if [[ ! -d "${RELEASE_DIR}" ]]; then
+ mkdir -p "${RELEASE_DIR}"
- if [[ "${SECOND_LINE}" != *"type: celix-doc"* ]]; then
- sed -i "1s;^;---\ntype: celix-doc\ntitle: ${FILE_NAME}\n---\n\n;" ${DEST_FILE}
- fi
+ CELIX_DOCS_DIR="${RELEASE_DIR}/celix"
- # Replace markdown links with HTML links
- sed -i "s/.md)/.html)/" ${DEST_FILE}
-done
+ for FILE_PATH in $(cd ${CELIX_SRC_DIR}; find . -name \*.md); do
+ # Retrieve file information
+ FILE_DIR="$(dirname ${FILE_PATH})"
+ FILE_NAME="$(basename ${FILE_PATH})"
+
+ # Copy markdown file to site destination
+ mkdir -p ${CELIX_DOCS_DIR}/${FILE_DIR}
+ cp -v ${CELIX_SRC_DIR}/${FILE_PATH} ${CELIX_DOCS_DIR}/${FILE_DIR}
+
+ # Prepend markdown file with Hugo header
+ DEST_FILE=${CELIX_DOCS_DIR}/${FILE_PATH}
+ SECOND_LINE=$(head -n 2 ${DEST_FILE} | tail -n 1)
+
+ if [[ "${SECOND_LINE}" != *"type: celix-doc"* ]]; then
+ sed -i "1s;^;---\ntype: celix-doc\ntitle: ${FILE_NAME}\nversion: ${RELEASE_VERSION}\n---\n\n;" ${DEST_FILE}
+ fi
+
+ # Replace markdown links with HTML links
+ sed -i "s/.md)/.html)/" ${DEST_FILE}
+ done
+else
+ echo "Not extracting docs, output directory already exists!"
+ exit 1
+fi
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
index 9d30c84..84bb47e 100644
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -42,7 +42,14 @@ limitations under the License.
<div class="row py-4">
<div class="col-sm-12 card">
<div class="card-body pt-5">
- <a class="edit-on-gh" href="{{ .Site.Params.siteRepositoryUrl }}/edit/{{ .Site.Params.siteRepositorySourceBranch }}/source/{{ .Page.File.Path }}" title="Edit this page on GitHub">Edit on GitHub</a>
+ {{ if isset .Params "version" }}
+ {{ $vers := .Param "version" }}
+ {{ if eq $vers .Site.Params.latestVersion }}
+ <a class="edit-on-gh" href="{{ .Site.Params.siteRepositoryUrl }}/edit/{{ .Site.Params.siteRepositorySourceBranch }}/source/{{ .Page.File.Path }}" title="Edit this page on GitHub">Edit on GitHub</a>
+ {{ end }}
+ {{ else }}
+ <a class="edit-on-gh" href="{{ .Site.Params.siteRepositoryUrl }}/edit/{{ .Site.Params.siteRepositorySourceBranch }}/source/{{ .Page.File.Path }}" title="Edit this page on GitHub">Edit on GitHub</a>
+ {{ end }}
{{ block "main" . }}{{ end }}
</div>
diff --git a/layouts/celix-doc/baseof.html b/layouts/celix-doc/baseof.html
index e29b09b..ed8f7de 100644
--- a/layouts/celix-doc/baseof.html
+++ b/layouts/celix-doc/baseof.html
@@ -42,9 +42,23 @@ limitations under the License.
<div class="row py-4">
<div class="col-sm-12 card">
<div class="card-body pt-5">
- {{ $page := replaceRE "TODO" "" .Page.File.Path }} <!-- TODO: .*(docs\/celix\/) -->
- <a class="edit-on-gh" href="{{ .Site.Params.repositoryUrl }}/edit/{{ .Site.Params.repositorySourceBranch }}/{{ $page }}" title="Edit this page on GitHub">Edit on GitHub</a>
- <a href="/docs/docs.html" title="back to documentation"><< back to documentation</a>
+ {{ $page := replaceRE "(^docs/.*/celix/)" "" .Page.File.Path }}
+ {{ if isset .Params "version" }}
+ {{ $vers := .Param "version" }}
+ {{ if eq $vers .Site.Params.latestVersion }}
+ <a class="edit-on-gh" href="{{ .Site.Params.repositoryUrl }}/edit/{{ .Site.Params.repositorySourceBranch }}/{{ $page }}" title="Edit this page on GitHub">Edit on GitHub</a>
+ {{ end }}
+ {{ else }}
+ <a class="edit-on-gh" href="{{ .Site.Params.repositoryUrl }}/edit/{{ .Site.Params.repositorySourceBranch }}/{{ $page }}" title="Edit this page on GitHub">Edit on GitHub</a>
+ {{ end }}
+
+ {{ if isset .Params "version" }}
+ {{ $version := .Param "version" }}
+ <a href="/docs/{{ $version }}/docs.html" title="back to documentation"><< back to documentation</a>
+ {{ else }}
+ {{ $version := .Site.Params.latestVersion }}
+ <a href="/docs/{{ $version }}/docs.html" title="back to documentation"><< back to documentation</a>
+ {{ end }}
{{ block "main" . }}{{ end }}
</div>
diff --git a/layouts/index.html b/layouts/index.html
index fb41638..ac66556 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -61,7 +61,7 @@ limitations under the License.
<i class="fas fa-download"></i> DOWNLOAD
</a>
- <a href="/docs/docs.html" class="btn btn-primary btn-lg mb-1">
+ <a href="/docs/{{ .Site.Params.latestVersion }}/docs.html" class="btn btn-primary btn-lg mb-1">
<i class="fas fa-book-open"></i> GETTING STARTED
</a>
</div>
diff --git a/layouts/partials/header.html b/layouts/partials/header.html
index f47aa96..1d4a81e 100644
--- a/layouts/partials/header.html
+++ b/layouts/partials/header.html
@@ -19,16 +19,24 @@
{{ if hasPrefix .Page.File.Path "download" }}<li class="nav-item active">{{ else }}<li class="nav-item">{{ end }}
<a class="nav-link" href="/download.cgi">Download</a>
</li>
- {{ if hasPrefix .Page.File.Path "docs" }}<li class="nav-item active">{{ else }}<li class="nav-item">{{ end }}
- <a class="nav-link" href="/docs/docs.html">Docs</a>
+ {{ if hasPrefix .Page.File.Path "docs" }}<li class="nav-item dropdown active">{{ else }}<li class="nav-item dropdown">{{ end }}
+ <a class="nav-link dropdown-toggle" href="#" id="ddDocs" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Docs
+ </a>
+ <div class="dropdown-menu" aria-labelledby="ddDocs">
+ <a class="dropdown-item" href="/docs/{{ .Site.Params.latestVersion }}/docs.html">{{ .Site.Params.latestVersion }} (latest)</a>
+ <a class="dropdown-item" href="/docs/2.1.0/docs.html">2.1.0</a>
+ </div>
</li>
{{ if hasPrefix .Page.File.Path "contributing" }}<li class="nav-item dropdown active">{{ else }}<li class="nav-item dropdown">{{ end }}
- <a class="nav-link dropdown-toggle" href="#" id="ddCommunity" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
- Community
+ <a class="nav-link dropdown-toggle" href="#" id="ddContributing" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Contributing
</a>
- <div class="dropdown-menu" aria-labelledby="ddCommunity">
+ <div class="dropdown-menu" aria-labelledby="ddContributing">
<a class="dropdown-item" href="/contributing/youatcelix.html">You at Celix</a>
<a class="dropdown-item" href="/contributing/submitting-patches.html">Submitting patches</a>
+ <a class="dropdown-item" href="/contributing/source-and-builds.html">Source code and builds</a>
+ <hr>
<a class="dropdown-item" href="/contributing/releasing.html">Releasing</a>
<a class="dropdown-item" href="/contributing/volunteers.html">Volunteers</a>
<a class="dropdown-item" href="https://whimsy.apache.org/board/minutes/Celix.html">Board Reports</a>
@@ -54,6 +62,7 @@
<a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
<a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
<a class="dropdown-item" href="https://www.apache.org/security/">Security</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/policies/conduct">Code of Conduct</a>
</div>
</li>
</ul>
diff --git a/source/contributing/source-and-builds.md b/source/contributing/source-and-builds.md
new file mode 100644
index 0000000..677502c
--- /dev/null
+++ b/source/contributing/source-and-builds.md
@@ -0,0 +1,69 @@
+---
+title: Source code and builds
+---
+
+# Source code and builds
+
+{{% tableofcontents %}}
+
+## Celix source repository
+
+Besides the archives offered on the [download](/download.cgi) page, Celix uses a source code repository hosted on both
+Apache and GitHub environments for development. This repository is mirrored and is our one-and-only development repository.
+
+With [Git](http://git-scm.com/) installed, obtaining a working copy of the Celix codebase is as simple as
+
+```
+> git clone https://gitbox.apache.org/repos/asf/celix.git
+```
+
+or from GitHub
+
+```
+> git clone https://github.com/apache/celix.git
+```
+
+For more about using version control systems at Apache, see the ASF's
+[Source Code Repositories](http://www.apache.org/dev/#version-control) page.
+
+### Building and using Celix
+
+How to build and use Celix is described within our 'Docs' section which can be found [here](/docs/{{< param "latestVersion" >}}/docs.html) for the latest release.
+
+## Website source repository
+
+The website Celix provides - https://celix.apache.org - is mostly written in Markdown and build using [Hugo](https://gohugo.io/).
+The website source code repository can be obtained using
+
+```
+> git clone https://gitbox.apache.org/repos/asf/celix-site.git
+```
+
+or from GitHub
+
+```
+> git clone https://github.com/apache/celix-site.git
+```
+
+### Building the website
+
+To generate the static website, execute `hugo` to generate and serve the website on `localhost:1313`.
+
+During development, it may be useful to run an incremental build. For this to work, execute `hugo server -D` to
+continuously generate and serve the website on `localhost:1313`.
+
+After making some changes and being ready to submit the work a pull request against the `celix-site` repository can be
+created. The celix-site repository has [Netlify](https://www.netlify.com) enabled meaning a bot will comment with a link
+to preview the actual site. For example the following pull request: [https://github.com/apache/celix-site/pull/7](https://github.com/apache/celix-site/pull/7#issuecomment-510947939).
+Per pull request a preview will be generated so new contributors are able to preview the generated site very quickly and
+reviewing new contributions will therefore be easier as well.
+
+<a href="https://www.netlify.com">
+ <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg"/>
+</a>
+
+<br/>
+<br/>
+
+After merging the change back to the `master` branch, [Jenkins](https://builds.apache.org/job/celix-site/)
+will be triggered for deploying the site to https://celix.apache.org.
diff --git a/source/contributing/submitting-patches.md b/source/contributing/submitting-patches.md
index 49f5da0..3661d7a 100644
--- a/source/contributing/submitting-patches.md
+++ b/source/contributing/submitting-patches.md
@@ -95,8 +95,8 @@ or GitHub
and done!
-Please remember Apache Celix is following the [GitFlow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
-and the most recent work is on the `develop` branch.
+<p class="alert alert-primary">Note: Remember that Apache Celix is following the <a href="https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow">GitFlow Workflow</a>
+and the most recent work is on the `develop` branch.</p>
## Non-committers
diff --git a/source/contributing/volunteers.md b/source/contributing/volunteers.md
index fff1642..8166629 100644
--- a/source/contributing/volunteers.md
+++ b/source/contributing/volunteers.md
@@ -11,13 +11,12 @@ community-based open source development.
## Project Management Committee Members
-Committee members are listed in the chronological order, according to the date each person become a committer
-or committee member.
+Committee members are listed in the chronological order, according to the date each person became a committee member.
- Alexander Broekhuis (abroekhuis at apache.org)
- Marcel Offermans (marss at apache.org)
- Konstantin I Boudnik (cos at apache.org)
-- Pepijn Noltes, Chairman (pnoltes at apache.org)
+- Pepijn Noltes (pnoltes at apache.org) **(Chairman)**
- Roman Shaposhnik (rvs at apache.org)
- Bjoern Petri (bpetri at apache.org)
- Erik Jansman (ejansman at apache.org)
@@ -31,3 +30,6 @@ Other committers are listed in the chronological order, according to the date ea
- Luciano Resende (lresende at apache.org)
- Karl Pauls (pauls at apache.org)
+- Daan Fischer (dfischer at apache.org)
+- Roy Bulter (rbulter at apache.org)
+- Idzard Hoekstra (idzardh at apache.org)
diff --git a/source/docs/celix/CHANGES.md b/source/docs/2.1.0/celix/CHANGES.md
similarity index 99%
rename from source/docs/celix/CHANGES.md
rename to source/docs/2.1.0/celix/CHANGES.md
index d372e20..eb6fac8 100644
--- a/source/docs/celix/CHANGES.md
+++ b/source/docs/2.1.0/celix/CHANGES.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: CHANGES.md
+title: Changes
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/README.md b/source/docs/2.1.0/celix/README.md
similarity index 99%
copy from source/docs/celix/README.md
copy to source/docs/2.1.0/celix/README.md
index f3a40be..0cdd50f 100644
--- a/source/docs/celix/README.md
+++ b/source/docs/2.1.0/celix/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
title: README.md
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/config_admin/readme.md b/source/docs/2.1.0/celix/config_admin/readme.md
similarity index 98%
copy from source/docs/celix/config_admin/readme.md
copy to source/docs/2.1.0/celix/config_admin/readme.md
index bcdbc13..9adcef7 100644
--- a/source/docs/celix/config_admin/readme.md
+++ b/source/docs/2.1.0/celix/config_admin/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Configuration Admin
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/dependency_manager/readme.md b/source/docs/2.1.0/celix/dependency_manager/readme.md
similarity index 99%
copy from source/docs/celix/dependency_manager/readme.md
copy to source/docs/2.1.0/celix/dependency_manager/readme.md
index 71d2e0a..8d7e55e 100644
--- a/source/docs/celix/dependency_manager/readme.md
+++ b/source/docs/2.1.0/celix/dependency_manager/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Dependency Manager
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/dependency_manager_cxx/readme.md b/source/docs/2.1.0/celix/dependency_manager_cxx/readme.md
similarity index 99%
copy from source/docs/celix/dependency_manager_cxx/readme.md
copy to source/docs/2.1.0/celix/dependency_manager_cxx/readme.md
index 9c09ff6..4c32f2e 100644
--- a/source/docs/celix/dependency_manager_cxx/readme.md
+++ b/source/docs/2.1.0/celix/dependency_manager_cxx/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: C++ Dependency Manager
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/deployment_admin/README.md b/source/docs/2.1.0/celix/deployment_admin/README.md
similarity index 97%
copy from source/docs/celix/deployment_admin/README.md
copy to source/docs/2.1.0/celix/deployment_admin/README.md
index d1e60c4..ca8828e 100644
--- a/source/docs/celix/deployment_admin/README.md
+++ b/source/docs/2.1.0/celix/deployment_admin/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Deployment Admin
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/device_access/README.md b/source/docs/2.1.0/celix/device_access/README.md
similarity index 97%
copy from source/docs/celix/device_access/README.md
copy to source/docs/2.1.0/celix/device_access/README.md
index bdd7467..f045142 100644
--- a/source/docs/celix/device_access/README.md
+++ b/source/docs/2.1.0/celix/device_access/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Device Access
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/building/readme.md b/source/docs/2.1.0/celix/documents/building/readme.md
similarity index 98%
copy from source/docs/celix/documents/building/readme.md
copy to source/docs/2.1.0/celix/documents/building/readme.md
index 3d914e1..00a18fb 100644
--- a/source/docs/celix/documents/building/readme.md
+++ b/source/docs/2.1.0/celix/documents/building/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Building and Installing
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/cmake_commands/readme.md b/source/docs/2.1.0/celix/documents/cmake_commands/readme.md
similarity index 99%
rename from source/docs/celix/documents/cmake_commands/readme.md
rename to source/docs/2.1.0/celix/documents/cmake_commands/readme.md
index 5e94ccc..9d38635 100644
--- a/source/docs/celix/documents/cmake_commands/readme.md
+++ b/source/docs/2.1.0/celix/documents/cmake_commands/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: CMake Commands
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md b/source/docs/2.1.0/celix/documents/getting_started/creating_a_simple_bundle.md
similarity index 99%
copy from source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
copy to source/docs/2.1.0/celix/documents/getting_started/creating_a_simple_bundle.md
index faacad7..f820c49 100644
--- a/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
+++ b/source/docs/2.1.0/celix/documents/getting_started/creating_a_simple_bundle.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: creating_a_simple_bundle.md
+title: Creating a Simple Bundle
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/getting_started/readme.md b/source/docs/2.1.0/celix/documents/getting_started/readme.md
similarity index 96%
copy from source/docs/celix/documents/getting_started/readme.md
copy to source/docs/2.1.0/celix/documents/getting_started/readme.md
index 93cf78c..ea54213 100644
--- a/source/docs/celix/documents/getting_started/readme.md
+++ b/source/docs/2.1.0/celix/documents/getting_started/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Getting Started Guide
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/getting_started/using_services_with_c.md b/source/docs/2.1.0/celix/documents/getting_started/using_services_with_c.md
similarity index 99%
copy from source/docs/celix/documents/getting_started/using_services_with_c.md
copy to source/docs/2.1.0/celix/documents/getting_started/using_services_with_c.md
index 7520154..0fd4197 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_c.md
+++ b/source/docs/2.1.0/celix/documents/getting_started/using_services_with_c.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: using_services_with_c.md
+title: Using Services with C
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/getting_started/using_services_with_cxx.md b/source/docs/2.1.0/celix/documents/getting_started/using_services_with_cxx.md
similarity index 99%
copy from source/docs/celix/documents/getting_started/using_services_with_cxx.md
copy to source/docs/2.1.0/celix/documents/getting_started/using_services_with_cxx.md
index 4669713..5d0e42c 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_cxx.md
+++ b/source/docs/2.1.0/celix/documents/getting_started/using_services_with_cxx.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: using_services_with_cxx.md
+title: Using Services with C++
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/intro/readme.md b/source/docs/2.1.0/celix/documents/intro/readme.md
similarity index 99%
copy from source/docs/celix/documents/intro/readme.md
copy to source/docs/2.1.0/celix/documents/intro/readme.md
index 90a9e04..cc5137e 100644
--- a/source/docs/celix/documents/intro/readme.md
+++ b/source/docs/2.1.0/celix/documents/intro/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Introduction
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/roadmap/api_v3/readme.md b/source/docs/2.1.0/celix/documents/roadmap/api_v3/readme.md
similarity index 99%
rename from source/docs/celix/documents/roadmap/api_v3/readme.md
rename to source/docs/2.1.0/celix/documents/roadmap/api_v3/readme.md
index 7160cdc..b1b44b8 100644
--- a/source/docs/celix/documents/roadmap/api_v3/readme.md
+++ b/source/docs/2.1.0/celix/documents/roadmap/api_v3/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Celix Version 3 (Proposal)
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/roadmap/improvement_ideas.md b/source/docs/2.1.0/celix/documents/roadmap/improvement_ideas.md
similarity index 98%
rename from source/docs/celix/documents/roadmap/improvement_ideas.md
rename to source/docs/2.1.0/celix/documents/roadmap/improvement_ideas.md
index a411598..0acda83 100644
--- a/source/docs/celix/documents/roadmap/improvement_ideas.md
+++ b/source/docs/2.1.0/celix/documents/roadmap/improvement_ideas.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: improvement_ideas.md
+title: Improvement Ideas
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/roadmap/roadmap.md b/source/docs/2.1.0/celix/documents/roadmap/roadmap.md
similarity index 99%
rename from source/docs/celix/documents/roadmap/roadmap.md
rename to source/docs/2.1.0/celix/documents/roadmap/roadmap.md
index 30c3ebb..083a962 100644
--- a/source/docs/celix/documents/roadmap/roadmap.md
+++ b/source/docs/2.1.0/celix/documents/roadmap/roadmap.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: roadmap.md
+title: Roadmap
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/documents/subprojects/readme.md b/source/docs/2.1.0/celix/documents/subprojects/readme.md
similarity index 99%
rename from source/docs/celix/documents/subprojects/readme.md
rename to source/docs/2.1.0/celix/documents/subprojects/readme.md
index dcfdd73..d15820e 100644
--- a/source/docs/celix/documents/subprojects/readme.md
+++ b/source/docs/2.1.0/celix/documents/subprojects/readme.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Subprojects
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/etcdlib/README.md b/source/docs/2.1.0/celix/etcdlib/README.md
similarity index 98%
copy from source/docs/celix/etcdlib/README.md
copy to source/docs/2.1.0/celix/etcdlib/README.md
index 8fbe866..80c1ae1 100644
--- a/source/docs/celix/etcdlib/README.md
+++ b/source/docs/2.1.0/celix/etcdlib/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Etcdlib
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/launcher/README.md b/source/docs/2.1.0/celix/launcher/README.md
similarity index 98%
copy from source/docs/celix/launcher/README.md
copy to source/docs/2.1.0/celix/launcher/README.md
index b1812ef..9a33c1c 100644
--- a/source/docs/celix/launcher/README.md
+++ b/source/docs/2.1.0/celix/launcher/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Launcher
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/log_service/README.md b/source/docs/2.1.0/celix/log_service/README.md
similarity index 97%
rename from source/docs/celix/log_service/README.md
rename to source/docs/2.1.0/celix/log_service/README.md
index f51fae9..19c8a1a 100644
--- a/source/docs/celix/log_service/README.md
+++ b/source/docs/2.1.0/celix/log_service/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Log Service
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.1.0/celix/log_writer/README.md
similarity index 96%
copy from source/docs/celix/log_writer/README.md
copy to source/docs/2.1.0/celix/log_writer/README.md
index 01a69c8..f80da6e 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.1.0/celix/log_writer/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Log Writer
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/pubsub/README.md b/source/docs/2.1.0/celix/pubsub/README.md
similarity index 98%
copy from source/docs/celix/pubsub/README.md
copy to source/docs/2.1.0/celix/pubsub/README.md
index 83fa8b4..0cc37ea 100644
--- a/source/docs/celix/pubsub/README.md
+++ b/source/docs/2.1.0/celix/pubsub/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Publisher / subscriber implementation
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/pubsub/examples/keys/README.md b/source/docs/2.1.0/celix/pubsub/examples/keys/README.md
similarity index 97%
copy from source/docs/celix/pubsub/examples/keys/README.md
copy to source/docs/2.1.0/celix/pubsub/examples/keys/README.md
index ee1300e..0bc2785 100644
--- a/source/docs/celix/pubsub/examples/keys/README.md
+++ b/source/docs/2.1.0/celix/pubsub/examples/keys/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Pubsub Keys
+version: 2.1.0
---
diff --git a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md b/source/docs/2.1.0/celix/pubsub/pubsub_admin_udp_mc/README.md
similarity index 99%
copy from source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md
copy to source/docs/2.1.0/celix/pubsub/pubsub_admin_udp_mc/README.md
index 8fd0ada..efef9cb 100644
--- a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md
+++ b/source/docs/2.1.0/celix/pubsub/pubsub_admin_udp_mc/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: PSA UDP Multicast
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/remote_services/README.md b/source/docs/2.1.0/celix/remote_services/README.md
similarity index 99%
copy from source/docs/celix/remote_services/README.md
copy to source/docs/2.1.0/celix/remote_services/README.md
index 33c9d6c..f25cf97 100644
--- a/source/docs/celix/remote_services/README.md
+++ b/source/docs/2.1.0/celix/remote_services/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Remote Service Admin Service
+version: 2.1.0
---
<!--
@@ -20,8 +21,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-Title: Apache Celix Remote Service Admin Service
-
## Introduction
The Remote Service Admin Service subproject contains an adapted implementation of the OSGi Enterprise Remote Service Admin Service Specification. The subproject consists of three parts, each described in more detail in the following sections.
diff --git a/source/docs/celix/remote_services/discovery_etcd/README.md b/source/docs/2.1.0/celix/remote_services/discovery_etcd/README.md
similarity index 97%
copy from source/docs/celix/remote_services/discovery_etcd/README.md
copy to source/docs/2.1.0/celix/remote_services/discovery_etcd/README.md
index 6ea6f7a..9dc7f24 100644
--- a/source/docs/celix/remote_services/discovery_etcd/README.md
+++ b/source/docs/2.1.0/celix/remote_services/discovery_etcd/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Discovery ETCD
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/remote_services/remote_service_admin/README.md b/source/docs/2.1.0/celix/remote_services/remote_service_admin/README.md
similarity index 97%
copy from source/docs/celix/remote_services/remote_service_admin/README.md
copy to source/docs/2.1.0/celix/remote_services/remote_service_admin/README.md
index f620015..89994e9 100644
--- a/source/docs/celix/remote_services/remote_service_admin/README.md
+++ b/source/docs/2.1.0/celix/remote_services/remote_service_admin/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Remote Service Admin
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/remote_services/topology_manager/README.md b/source/docs/2.1.0/celix/remote_services/topology_manager/README.md
similarity index 96%
copy from source/docs/celix/remote_services/topology_manager/README.md
copy to source/docs/2.1.0/celix/remote_services/topology_manager/README.md
index f75059c..3201aa1 100644
--- a/source/docs/celix/remote_services/topology_manager/README.md
+++ b/source/docs/2.1.0/celix/remote_services/topology_manager/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Topology Manager
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/remote_shell/README.md b/source/docs/2.1.0/celix/remote_shell/README.md
similarity index 96%
copy from source/docs/celix/remote_shell/README.md
copy to source/docs/2.1.0/celix/remote_shell/README.md
index bf1eb8a..cb516ca 100644
--- a/source/docs/celix/remote_shell/README.md
+++ b/source/docs/2.1.0/celix/remote_shell/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Remote Shell
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/shell/README.md b/source/docs/2.1.0/celix/shell/README.md
similarity index 98%
copy from source/docs/celix/shell/README.md
copy to source/docs/2.1.0/celix/shell/README.md
index e680d92..b572dcc 100644
--- a/source/docs/celix/shell/README.md
+++ b/source/docs/2.1.0/celix/shell/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Shell
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/shell_tui/README.md b/source/docs/2.1.0/celix/shell_tui/README.md
similarity index 97%
copy from source/docs/celix/shell_tui/README.md
copy to source/docs/2.1.0/celix/shell_tui/README.md
index 559004c..74e28e0 100644
--- a/source/docs/celix/shell_tui/README.md
+++ b/source/docs/2.1.0/celix/shell_tui/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Shell TUI
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/utils/README.md b/source/docs/2.1.0/celix/utils/README.md
similarity index 97%
copy from source/docs/celix/utils/README.md
copy to source/docs/2.1.0/celix/utils/README.md
index 3cec0fc..f6f56bd 100644
--- a/source/docs/celix/utils/README.md
+++ b/source/docs/2.1.0/celix/utils/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Utils
+version: 2.1.0
---
<!--
diff --git a/source/docs/celix/utils/docs/thpool/Design.md b/source/docs/2.1.0/celix/utils/docs/thpool/Design.md
similarity index 98%
copy from source/docs/celix/utils/docs/thpool/Design.md
copy to source/docs/2.1.0/celix/utils/docs/thpool/Design.md
index 2908f86..c0ee5c2 100644
--- a/source/docs/celix/utils/docs/thpool/Design.md
+++ b/source/docs/2.1.0/celix/utils/docs/thpool/Design.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: Design.md
+title: C Thread Pool Design
+version: 2.1.0
---
## High level
diff --git a/source/docs/celix/utils/docs/thpool/FAQ.md b/source/docs/2.1.0/celix/utils/docs/thpool/FAQ.md
similarity index 98%
copy from source/docs/celix/utils/docs/thpool/FAQ.md
copy to source/docs/2.1.0/celix/utils/docs/thpool/FAQ.md
index 7ef617d..3526d2b 100644
--- a/source/docs/celix/utils/docs/thpool/FAQ.md
+++ b/source/docs/2.1.0/celix/utils/docs/thpool/FAQ.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: FAQ.md
+title: C Thread Pool FAQ
+version: 2.1.0
---
diff --git a/source/docs/celix/utils/docs/thpool/README.md b/source/docs/2.1.0/celix/utils/docs/thpool/README.md
similarity index 98%
copy from source/docs/celix/utils/docs/thpool/README.md
copy to source/docs/2.1.0/celix/utils/docs/thpool/README.md
index 31d86b1..b8f8e22 100644
--- a/source/docs/celix/utils/docs/thpool/README.md
+++ b/source/docs/2.1.0/celix/utils/docs/thpool/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: C Thread Pool
+version: 2.1.0
---

diff --git a/source/docs/celix/utils/public/include/memstream/README.md b/source/docs/2.1.0/celix/utils/public/include/memstream/README.md
similarity index 98%
copy from source/docs/celix/utils/public/include/memstream/README.md
copy to source/docs/2.1.0/celix/utils/public/include/memstream/README.md
index 4058c0b..897e0ad 100644
--- a/source/docs/celix/utils/public/include/memstream/README.md
+++ b/source/docs/2.1.0/celix/utils/public/include/memstream/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: memstream
+version: 2.1.0
---
fmemopen for Mac OS and iOS
diff --git a/source/docs/2.1.0/docs.md b/source/docs/2.1.0/docs.md
new file mode 100644
index 0000000..7f29081
--- /dev/null
+++ b/source/docs/2.1.0/docs.md
@@ -0,0 +1,25 @@
+---
+title: Documentation for v2.1.0
+version: 2.1.0
+---
+
+# Documentation for Celix v2.1.0
+
+Get started with Celix by going through the appropriate content.
+
+Please follow the links below to find appropriate content:
+
+ - [Introduction](./celix/documents/intro/readme.html)
+ - [Getting Started](./celix/documents/getting_started/readme.html)
+ - [CMake Commands](./celix/documents/cmake_commands/readme.html)
+ - [Building](./celix/documents/building/readme.html)
+ - [Subprojects](./celix/documents/subprojects/readme.html)
+
+View our roadmap to view future plans for Celix
+
+ - [Roadmap](./celix/documents/roadmap/roadmap.html)
+
+View the 2.1.0 changelog [here](./celix/CHANGES.html).
+
+> The [Celix mailing list](/support/mailing-list.html) is an excellent place to reach out for help. If you don't find
+> an answer to your problem in the mailing list archives, post a new question on the mailing list.
diff --git a/source/docs/2.2.0/celix/CHANGES.md b/source/docs/2.2.0/celix/CHANGES.md
new file mode 100644
index 0000000..9dba7b9
--- /dev/null
+++ b/source/docs/2.2.0/celix/CHANGES.md
@@ -0,0 +1,282 @@
+---
+type: celix-doc
+title: Changes
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Changes for 2.2.0
+
+## New features:
+- PubSub TCP (donation)
+- PubSub Avro bin serializer
+- PubSub Websocket (donation)
+- HTTP Admin (donation)
+- Shell Web UI (using HTTP Admin) d
+
+## Improvements
+- CELIX-438: Refactored celix api so that include files and symbols have a _celix "namespace"
+- CELIX-459: Adds PubSub health/usage monitoring
+- CELIX-467: Adds doxygen generation
+- Refactored etcdlib to supported multiple instances
+
+## Bugs
+- CELIX-410: Fixes issue with property loader duplicating spaces and tabs
+- CELIX-454: Fixed race condition in the etcd pubsub discovery
+- CELIX-460: Fixed issue with msg not found in pub/sub serializer map due to signed/unsigned difference
+- CELIX-466: Fixed race condition Race condition in adding/removing service listener hooks
+
+# Changes for 2.1.0
+
+## New Features:
+- CELIX-408: Adds support for generating runtime shell scripts so that multiple Celix containers and other executable can be run with a single command.
+- CELIX-418: Adds support for generating properties in the Celix container launcher.
+- CELIX-407: Adds support for serializers as a service for PubSub. This way PubSubAdmin are purely focused on transport techniques.
+- CELIX-401: Adds support for creating Celix docker images using a CMake function.
+- CELIX-397: Adds support for PubSub selection based on a match function. This way multiple PubSubAdmin can be active.
+- CELIX-389: Adds the PubSub implementation. A set of bundles which together operates as a service based publish subscribe technology agnostic abstraction.
+- CELIX-385: Adds etcdlib as library. This libray can be used to communicate with etcd using a C abstraction.
+- CELIX-370: Adds C++11 support by adding a C++ Dependency Manager library. This is moslty a header based library.
+
+## Improvements:
+- CELIX-415: Improves handling of ANSI control sequences to better support running in IDE's.
+- CELIX-414: Improves support for running Celix container inside IDE's by basicly handling Celix containers as add_executable CMake target.
+- CELIX-406: Improves handling of descriptor files, by allowing different directories for Remote Services and PubSub.
+- CELIX-399: Improves PubSub to use etcdlib instead of local copy of etcd.c file.
+- CELIX-396: Improves the ZMQ PubSub security so that enabling/disable of security can be done per topic.
+- CELIX-395: Improves Remote Service to use the etcdlib instead of a local etcd.c file.
+- CELIX-392: Removes the use of the deprecated readdir_r function.
+
+## Bugs:
+- CELIX-416: Fixes an issue for the Android build.
+- CELIX-410: Fixes an issue where spaces and tabs are duplicated when loading properties.
+- CELIX-405: Fixes an issue with crashes because of invalid DFI descriptors.
+- CELIX-404: Fixes an issue with crashes using the inspect shell command.
+- CELIX-403: Fixes an memory leak in the service tracker.
+- CELIX-400: Fixes an issue with private libraries being loaded twice.
+- CELIX-398: Fixes an issue with PubSub and multiple UDP connections.
+- CELIX-393: Fixes an issue with the add_bundle CMake function and using existing libaries.
+- CELIX-391: Fixes an issue with the utils_stringHash not genering unique (enough) hashes.
+- CELIX-390: Fixes an issue with cycle dependency between the Celix framework and Celix utils libraries.
+- CELIX-387: Fixes an issue with the travis build and OSX
+- CELIX-386: Fixes an issue with the C++ dependency manager and register multiple C++ services.
+
+# Changes for 2.0.0
+
+## New Features
+- CELIX-77 Configuration Admin Implementation
+- CELIX-116 Event admin
+- CELIX-119 Remove apr usage from framework
+- CELIX-172 Bonjour Shell
+- CELIX-237 RSA with libffi
+- CELIX-269 New Dependency Manager
+- CELIX-370 Add C++ support
+
+## Improvements
+- CELIX-63 make cmake directory useable for custom bundle projects
+- CELIX-66 Refactor shell service struct
+- CELIX-90 add additional build options for RSA components
+- CELIX-111 Support multiple libraries
+- CELIX-115 logservice bundle entries list grows indefinitely
+- CELIX-118 Deployment Admin - Support auditlog of Apache ACE
+- CELIX-123 enable code coverage for utils_test
+- CELIX-125 CMakeCelix module
+- CELIX-134 Update source from incubator structure to TLP
+- CELIX-138 Parameterise launcher
+- CELIX-144 Document Developing Celix with Eclipse
+- CELIX-146 Replace printfs wit fw_log calls
+- CELIX-149 Add log_writer_syslog
+- CELIX-152 Added Discovery/ETCD support
+- CELIX-153 add cmake configuration options for rsa_bundles
+- CELIX-156 Enable all warnings
+- CELIX-158 RSA is unable to re-use already started proxy factory
+- CELIX-165 Add port collision auto-correction to RSA
+- CELIX-169 Add port collision auto-correction to discovery
+- CELIX-182 loghelper eases log_service tracking
+- CELIX-187 discovery_etcd: add watchindex, handle expire action
+- CELIX-193 support portable celix_thread_t initalization
+- CELIX-199 Code Coverage should be optional rather than required by cmake
+- CELIX-200 SEGFAULT occurs when remote services are closed
+- CELIX-216 Replace strtok with strtok_r
+- CELIX-230 Refactoring of the shell command service
+- CELIX-242 Fix Warnings
+- CELIX-245 Update civetweb to latest version
+- CELIX-246 enable Travis CI for Apache Celix
+- CELIX-247 Enable ANDROID support
+- CELIX-249 Refactor most char * usage to const char *
+- CELIX-251 missing includes in device access example
+- CELIX-255 Update default BUILD option
+- CELIX-258 framework uses dlopen/dlsym to set the bundleActivator
+- CELIX-259 dispatcherThread does not perform a graceful shutdown
+- CELIX-275 Can't do mkstemp on root system (deploymentAdmin_download)
+- CELIX-278 Adding tags to ACE target through deployment admin
+- CELIX-284 Restrict export and imports based on properties
+- CELIX-285 Discovery SHM: remove obsolete jansson dependency
+- CELIX-295 Many compiling warnings in unit tests
+- CELIX-296 Framework unit tests improvement
+- CELIX-309 Make DFI available for common use
+- CELIX-317 Dependency Manager suspend state
+- CELIX-320 outdated utils tests (threads, hashmap)
+- CELIX-323 Version and version_range moved from framework to utils
+- CELIX-326 Add service version support to dependency manager
+- CELIX-327 Filter does not support greater than and lesser than operators
+- CELIX-328 Service version support for RSA DFI
+- CELIX-330 document using markdown
+- CELIX-333 integrate coverity scans
+- CELIX-335 Refactor deploying bundles with cmake
+- CELIX-339 celix_log_mock doesnt show logs to the user
+- CELIX-341 Fix coverity issues in Shell / Shell TUI
+- CELIX-348 The utils_stringHash does not generate unique hashes.
+- CELIX-352 RSA_DFI and embedded celix
+- CELIX-353 Make bundle context retrievable form dm component
+- CELIX-365 Refactor some usage of void* to const void*
+
+## Bugs
+- CELIX-104 deployment_admin bundle won't start when missing properties
+- CELIX-105 Fixed array_list_test
+- CELIX-114 Potential deadlock in log_service bundle during stop
+- CELIX-122 missing dependency uuid
+- CELIX-124 Celix memory leaks fixing
+- CELIX-127 Makefiles not generated using CMake 3.0
+- CELIX-128 remote_shell port cannot be changed
+- CELIX-129 Update RSA to be compatible with the Amdatu RSA implementation
+- CELIX-130 Implement Configured Endpoint discovery compatible with Amdatu RSA
+- CELIX-136 contrib Configured endpoint discovery
+- CELIX-137 Possible concurrency issues in topology manager
+- CELIX-139 Update tests and mocks to latest CppUTest
+- CELIX-147 RSA_SHM: concurrency issue when client segfaults
+- CELIX-150 Topology Manager segfaults when RSA/bundle w/ exp. service stops in wrong order
+- CELIX-154 echo exampe not working
+- CELIX-155 Fix CMake warnings during configuration
+- CELIX-157 service_reference misses functions to get property keys and values
+- CELIX-159 PThread usage not correct for Linux
+- CELIX-161 newly added RSA cannot manage already exported/imported services
+- CELIX-162 Update encoding/decoding of replies.
+- CELIX-167 Update command to be able to pass a pointer (handle)
+- CELIX-168 discovery_etcd:Make root-path configurable
+- CELIX-170 Remote services can fail to restart when felix restarts
+- CELIX-173 stopping rsa_http bundle does not stop rsa webserver
+- CELIX-174 invalid bundle_context during fw shutdown
+- CELIX-175 segfault during shutdown when calculator is already stopped
+- CELIX-177 not all endpoints are unistalled when rsa_http bundle is stopped
+- CELIX-178 Shell_Tui bundle hangs on stop
+- CELIX-179 memory leak in rsa_http callback
+- CELIX-180 framework_tests do not compile
+- CELIX-181 Incorrect reply status when no data is returned on a remote call.
+- CELIX-185 Memory leaks in Discovery Endpoint Descriptor Reader
+- CELIX-186 deployment_admin segfaults while downloading bundle
+- CELIX-188 Add missing log_service headers to installations
+- CELIX-189 LogService segfaults when log message pointer is overwritten
+- CELIX-190 remote services memory leaks
+- CELIX-192 rsa_http: add locking
+- CELIX-194 Refactor RemoteService proxy factory
+- CELIX-195 SEGFAULT occurs when running a log command.
+- CELIX-197 insufficient memory allocated
+- CELIX-198 Logging can segfault for strings 512 characters or longer
+- CELIX-201 SEGFAULT occurs when restarting apache_celix_rs_topology_manager
+- CELIX-202 Not all components are disabled with a clean build
+- CELIX-205 RSA Discovery (Configured) bundle gets stuck
+- CELIX-213 SEGFAULT occurs due to memory access after memory is free'd
+- CELIX-215 curl_global_init() not called directly
+- CELIX-218 Memory leaks in service_registry.c
+- CELIX-219 Memory Leaks
+- CELIX-221 Deployment admin segfaults when deploying a bundle
+- CELIX-223 Celix crashes because of wrong bundle versions
+- CELIX-224 Wrong use of errno in launcher.c
+- CELIX-226 __unused atttibute does not work with Linux
+- CELIX-227 compile error under linux due to missing header include
+- CELIX-229 Make APR optional
+- CELIX-231 Missing log_helper creation in discovery_etcd
+- CELIX-238 Contributing page links incorrect
+- CELIX-239 TopologyManager does not maintain exportedServices
+- CELIX-240 RSA: deadlock when stopping
+- CELIX-241 remote_interface incorrect
+- CELIX-248 too many arguments for format
+- CELIX-250 config.h is not exported
+- CELIX-252 discovery_etcd cannot handle celix restarts
+- CELIX-253 Deployment admin does not always download the latest version from ACE
+- CELIX-254 Memory leakage in deployment_admin
+- CELIX-260 missing include in deployment admin
+- CELIX-262 Fix minor issues in hashMap/linkedList
+- CELIX-263 replace utils cunit tests w/ cpputest tests
+- CELIX-264 Missing strdup leads to invalid free
+- CELIX-270 Fix Code Coverage
+- CELIX-271 setup coveralls.io
+- CELIX-272 framework: improve locking / synchronization
+- CELIX-274 waitForShutdown issue when starting two embedded celix frameworks.
+- CELIX-279 Celix fails to compile w/ CMake 3.3
+- CELIX-280 deployment_admin misses proper shutdown functionality
+- CELIX-287 racecondition for framework event listener
+- CELIX-288 Archive directory not properly read
+- CELIX-289 Fix celix mocks
+- CELIX-290 Mock fixes, CMakelist fix, build warning fix
+- CELIX-292 Memory leak in refactored shell
+- CELIX-294 changed dfi library from static to shared
+- CELIX-298 Memory leaks in rsa_dfi
+- CELIX-300 Invalid read in serviceRegistry during framework_shutdown
+- CELIX-301 Memory leaks in rsa_shm
+- CELIX-302 Service Tracker Test error breaks the build
+- CELIX-304 Memory leaks in manifest parser, requirement, capability; out-of-date tests
+- CELIX-305 Memory leaks in RSA_SHM, RSA_DFI, RSA_HTTP
+- CELIX-306 Memory leaks in remote_proxy_factory, unit tests issues
+- CELIX-307 "service registration set properties" deadlocks
+- CELIX-308 Dependency Manager memory leaks
+- CELIX-310 "serviceRegistry_getRegisteredServices" deadlocks
+- CELIX-311 Framework Tests Build broken
+- CELIX-312 ServiceReference usage counter inconsistent state
+- CELIX-313 out of date/defunct tests
+- CELIX-316 Wrong conversion for 'N' type in json_serializer
+- CELIX-322 Memory leaks in resolver and framework tests
+- CELIX-324 Version support in dfi library
+- CELIX-325 Bundle test sporadicly fails
+- CELIX-329 framework "service_" tests are outdates, some small bugs in the sources
+- CELIX-331 test configuraiton needs update for newer CMake
+- CELIX-332 filter tests absent, small bugs in the source
+- CELIX-334 Race Condition in Topology Manager causes spurious segfaults
+- CELIX-336 resolver_test doesn't compile
+- CELIX-343 configuration_unbind never called
+- CELIX-344 service tracker removes wrong service
+- CELIX-345 Typo in Dependency Manager interface
+- CELIX-346 celix-bootstrap problems
+- CELIX-347 Memory leaks in dm_service_dependency
+- CELIX-349 ServiceTracker update references list after invoking added callback
+- CELIX-350 shell_tui wrong handling service reference
+- CELIX-354 Coverity High Impact issues
+- CELIX-356 Import libraries not supported in revamped cmake commands
+- CELIX-357 Coverity Medium Impact issues
+- CELIX-358 Coverity Low+New High Impact issues
+- CELIX-359 Android build stopped working
+- CELIX-360 Coverity leftover issues
+- CELIX-361 etcd_watcher notifications loss when ETCD transaction rate is high
+- CELIX-363 Memory leak in DFI exportRegistration_create
+- CELIX-364 Incorrect destroy of dependency manager info struct
+- CELIX-366 eclipse launch file not correctly generated
+- CELIX-367 Memory leak in properties
+- CELIX-369 Tests fail with sanitizer
+- CELIX-371 Due to a fixed maximum length of lines in property file not all bundles are started
+- CELIX-372 serviceRegistry_clearReferencesFor warning info unclear
+- CELIX-373 Endpoint Server number is fixed and too low
+- CELIX-374 RTLD_NODELETE flag
+- CELIX-375 Topology manager deadlocks when interacts with dependency manager
+- CELIX-377 wrong rpath setup in CMake files
+- CELIX-378 Travis build errors on Max OSX
+- CELIX-379 Extend cmake fucntion add_deploy with an option to specify the launcher
+- CELIX-376 serviceRegistration sometimes paired to invalidated serviceReference
+- CELIX-380 PROPERTIES_FOR_EACH macro does not iterate over all keys
+- CELIX-381 Invoke set for dependency manager called before suspending the component
diff --git a/source/docs/celix/README.md b/source/docs/2.2.0/celix/README.md
similarity index 84%
rename from source/docs/celix/README.md
rename to source/docs/2.2.0/celix/README.md
index f3a40be..35b0083 100644
--- a/source/docs/celix/README.md
+++ b/source/docs/2.2.0/celix/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
title: README.md
+version: 2.2.0
---
<!--
@@ -21,14 +22,14 @@ limitations under the License.
-->
# Apache Celix [](https://travis-ci.org/apache/celix) [](https://coveralls.io/github/apache/celix?branch=develop) [](https://scan.coverity.com/projects/6685)
-Apache Celix is an implementation of the OSGi specification adapted to C and C++ (C++11). It is a provides a framework to develop (dynamic) modular software applications using component and/or service-oriented programming.
+Apache Celix is an implementation of the OSGi specification adapted to C and C++ (C++11). It is a framework to develop (dynamic) modular software applications using component and/or service-oriented programming.
## Building
-For information how to build Apache Celix see [Building Apache Celix](documents/building/readme.html)
+For information how to build Apache Celix see [Building Apache Celix](documents/building/README.html)
## Introduction to Apache Celix
-For an introduction into Apache Celix see [Apache Celix Intro](documents/intro/readme.html)
+For an introduction into Apache Celix see [Apache Celix Intro](documents/intro/README.html)
## Getting Started with Apache Celix
-For a guide how to start writing your own bundles and services see [Getting Started Guide](documents/getting_started/readme.html)
+For a guide how to start writing your own bundles and services see [Getting Started Guide](documents/getting_started/README.html)
diff --git a/source/docs/celix/deployment_admin/README.md b/source/docs/2.2.0/celix/bundles/deployment_admin/README.md
similarity index 66%
rename from source/docs/celix/deployment_admin/README.md
rename to source/docs/2.2.0/celix/bundles/deployment_admin/README.md
index d1e60c4..bb174e0 100644
--- a/source/docs/celix/deployment_admin/README.md
+++ b/source/docs/2.2.0/celix/bundles/deployment_admin/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Deployment Admin
+version: 2.2.0
---
<!--
@@ -27,10 +28,20 @@ The Celix Deployment Admin implements the OSGi Deployment Admin specification, w
It can be used for example with Apache Ace, which allows you to centrally manage and distribute software components, configuration data and other artifacts.
###### Properties
- deployment_admin_identification id used by the deployment admin to identify itself
- deployment_admin_url url of the deployment server
- deployment_cache_dir possible cache dir for the deployment admin update
- deployment_tags tags used by the deployment admin
+ tags used by the deployment admin
-###### CMake option
+## CMake option
BUILD_DEPLOYMENT_ADMIN=ON
+
+## Deployment Admin Config Options
+
+- deployment_admin_identification id used by the deployment admin to identify itself
+- deployment_admin_url url of the deployment server
+- deployment_cache_dir possible cache dir for the deployment admin update
+- deployment_tags
+
+## Using info
+
+If the Celix Deployment Admin is installed, 'find_package(Celix)' will set:
+ - The `Celix::deployment_admin_api` interface (i.e. headers only) library target
+ - The `Celix::deployment_admin` bundle target
diff --git a/source/docs/celix/device_access/README.md b/source/docs/2.2.0/celix/bundles/device_access/README.md
similarity index 77%
copy from source/docs/celix/device_access/README.md
copy to source/docs/2.2.0/celix/bundles/device_access/README.md
index bdd7467..3ed3e5a 100644
--- a/source/docs/celix/device_access/README.md
+++ b/source/docs/2.2.0/celix/bundles/device_access/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Device Access
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -24,9 +25,16 @@ limitations under the License.
The Device Access contains a for Celix adapted implementation of the OSGi Compendium Device Access Specification.
-###### Properties
+## Properties
DRIVER_LOCATOR_PATH Path to the directory containing the driver bundles, defaults to "drivers".
The Driver Locator uses this path to find drivers.
-###### CMake option
+## CMake option
BUILD_DEVICE_ACCESS=ON
+
+## Using info
+
+If the Celix Device Access is installed, 'find_package(Celix)' will set:
+ - The `Celix::device_access_api` interface (i.e. headers only) library target
+ - The `Celix::device_manager` bundle target
+ - The `Celix::driver_locator` bundle target
diff --git a/source/docs/celix/device_access/README.md b/source/docs/2.2.0/celix/bundles/device_access/example/base_driver/README.md
similarity index 61%
rename from source/docs/celix/device_access/README.md
rename to source/docs/2.2.0/celix/bundles/device_access/example/base_driver/README.md
index bdd7467..d5974ac 100644
--- a/source/docs/celix/device_access/README.md
+++ b/source/docs/2.2.0/celix/bundles/device_access/example/base_driver/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Base driver
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,13 +21,11 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Device Access
-
-The Device Access contains a for Celix adapted implementation of the OSGi Compendium Device Access Specification.
+# Base driver
-###### Properties
- DRIVER_LOCATOR_PATH Path to the directory containing the driver bundles, defaults to "drivers".
- The Driver Locator uses this path to find drivers.
+The base driver is a "special" driver that will not be loaded by the device manager.
+Normally the device manager will load drivers if it find device which are idle... But before that can happen
+at least one device should exists. This is the role of a base driver and it should function like a "normal" OSGi
+bundle which registers a device service.
-###### CMake option
- BUILD_DEVICE_ACCESS=ON
+In this example the base driver will provide two device service with a DEVICE_CATEGORY of "char".
\ No newline at end of file
diff --git a/source/docs/celix/utils/README.md b/source/docs/2.2.0/celix/bundles/device_access/example/consuming_driver/README.md
similarity index 71%
copy from source/docs/celix/utils/README.md
copy to source/docs/2.2.0/celix/bundles/device_access/example/consuming_driver/README.md
index 3cec0fc..05477de 100644
--- a/source/docs/celix/utils/README.md
+++ b/source/docs/2.2.0/celix/bundles/device_access/example/consuming_driver/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Consuming driver
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,15 +21,9 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Utils
-
-Celix Utils contains several useful containers/lists implementation used with the Celix project. The following types are available:
+# Consuming driver
- Array List
- Celix Thread Container
- Hash Map
- Linked List
- Thread Pool
+A consuming driver will be able to attach to certain device services,
+but will not - in contrast with a refining driver - publish device services.
-###### CMake option
- BUILD_UTILS=ON
+In this example the consuming driver will look for "word" services and will print the result a few times.
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.2.0/celix/bundles/device_access/example/refining_driver/README.md
similarity index 68%
copy from source/docs/celix/log_writer/README.md
copy to source/docs/2.2.0/celix/bundles/device_access/example/refining_driver/README.md
index 01a69c8..296b510 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.2.0/celix/bundles/device_access/example/refining_driver/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Refining driver
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,10 +21,9 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Log Writer
-
-The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
+# Refining driver
-###### CMake options
- BUILD_LOG_WRITER=ON
- BUILD_LOG_WRITER_SYSLOG=ON
+A refining driver is a driver which is able to attach to certain device services and
+as result publishes different - refined - device services.
+This example will attach to device services with a "char" device category and publish
+- for every char device services found - a "word" device services.
diff --git a/source/docs/2.2.0/celix/bundles/http_admin/README.md b/source/docs/2.2.0/celix/bundles/http_admin/README.md
new file mode 100644
index 0000000..542fa20
--- /dev/null
+++ b/source/docs/2.2.0/celix/bundles/http_admin/README.md
@@ -0,0 +1,57 @@
+---
+type: celix-doc
+title: HTTP Admin
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+## HTTP Admin
+
+The HTTP admin provides a service tracker and starts a HTTP web server. The civetweb web server is used as an embedded
+web server. Websockets are supported by the HTTP admin.
+
+Services can register and implement HTTP requests or websocket support for a specified URI.
+The supported HTTP requests are: GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS and PATCH.
+The websocket service can support different callback handlers: connect, ready, data and close.
+
+Aliasing is also supported for both HTTP services and websocket services. Multiple aliases can be added by using the comma as seperator.
+Adding aliasing is done by adding the following function to the target CMakeFile (fill in <Alias path> and <Path to destination>):
+
+```CMake
+celix_bundle_headers(<TARGET>
+ "X-Web-Resource: /<Alias path>$<SEMICOLON>/<Path to destination>, /<Alias path 2>$<SEMICOLON>/<Path to destination>"
+)
+```
+
+Bundle alias resources can be added by the with the following function in the bundle CMakefile:
+
+```CMake
+celix_bundle_add_dir(<TARGET> <Document root of bundle> DESTINATION ".")
+```
+
+### Celix supported config.properties
+ CELIX_HTTP_ADMIN_LISTENING_PORTS default = 8080, can be multiple ports divided by a comma
+ CELIX_HTTP_ADMIN_PORT_RANGE_MIN default = 8000
+ CELIX_HTTP_ADMIN_PORT_RANGE_MAX default = 9000
+ CELIX_HTTP_ADMIN_USE_WEBSOCKETS default = true
+ CELIX_HTTP_ADMIN_WEBSOCKET_TIMEOUT_MS default = 3600000
+ CELIX_HTTP_ADMIN_NUM_THREADS default = 1
+
+## CMake option
+ BUILD_HTTP_ADMIN=ON
diff --git a/source/docs/2.2.0/celix/bundles/logging/log_service/README.md b/source/docs/2.2.0/celix/bundles/logging/log_service/README.md
new file mode 100644
index 0000000..f219375
--- /dev/null
+++ b/source/docs/2.2.0/celix/bundles/logging/log_service/README.md
@@ -0,0 +1,25 @@
+---
+type: celix-doc
+title: Log Service
+version: 2.2.0
+---
+
+# Log Service
+
+The Celix Log Service realizes an adapted implementation of the OSGi Compendium Log Service. This is a very simple implementation which only stores the log in memory. It can be combined with one of the available Log Writers to forward the buffered entries to e.g. stdout or syslog.
+
+To ease the use of the Log Service, the [Log Helper](loghelper_include/log_helper.h) can be used. It wraps and therefore simplifies the log service usage.
+
+## Properties
+ LOGHELPER_ENABLE_STDOUT_FALLBACK If set to any value and in case no Log Service is found the logs
+ are still printed on stdout.
+
+## CMake option
+ BUILD_LOG_SERVICE=ON
+
+## Using info
+
+If the Celix Log Service is installed, 'find_package(Celix)' will set:
+ - The `Celix::log_service_api` interface (i.e. header only) library target
+ - The `Celix::log_service` bundle target
+ - The `Celix::log_helper` static library target
diff --git a/source/docs/2.2.0/celix/bundles/logging/log_writer/README.md b/source/docs/2.2.0/celix/bundles/logging/log_writer/README.md
new file mode 100644
index 0000000..6108fc6
--- /dev/null
+++ b/source/docs/2.2.0/celix/bundles/logging/log_writer/README.md
@@ -0,0 +1,19 @@
+---
+type: celix-doc
+title: Log Writer
+version: 2.2.0
+---
+
+# Log Writer
+
+The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
+
+## CMake options
+ BUILD_LOG_WRITER=ON
+ BUILD_LOG_WRITER_SYSLOG=ON
+
+## Using info
+
+If the Celix Log Writers are installed `find_package(CELIX)` will set:
+ - The `Celix::log_writer_stdout` bundle target
+ - The `Celix::log_writer_syslog` bundle target
diff --git a/source/docs/celix/pubsub/README.md b/source/docs/2.2.0/celix/bundles/pubsub/README.md
similarity index 88%
rename from source/docs/celix/pubsub/README.md
rename to source/docs/2.2.0/celix/bundles/pubsub/README.md
index 83fa8b4..05c6b5b 100644
--- a/source/docs/celix/pubsub/README.md
+++ b/source/docs/2.2.0/celix/bundles/pubsub/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Publisher / subscriber implementation
+version: 2.2.0
---
<!--
@@ -87,3 +88,13 @@ For ZeroMQ without encryption, start here
1. Run `cd deploy/pubsub/pubsub_subscriber_zmq`
1. Run `cat ~/pubsub.conf >> config.properties` (only for ZeroMQ with encryption)
1. Run `sh run.sh`
+
+### Properties PSA ZMQ
+
+Some properties can be set to configure the PSA-ZMQ. If not configured defaults will be used. These
+properties can be set in the config.properties file (<PROPERTY>=<VALUE> format)
+
+
+ PSA_IP The local IP address to be used by the ZMQ admin to publish its data. Default te first IP not on localhost
+ PSA_INTERFACE The local ethernet interface to be used by the ZMQ admin to publish its data (ie eth0). Default the first non localhost interface
+ PSA_ZMQ_RECEIVE_TIMEOUT_MICROSEC Set the polling interval of the ZMQ receive thread. Default 1ms
\ No newline at end of file
diff --git a/source/docs/celix/pubsub/examples/keys/README.md b/source/docs/2.2.0/celix/bundles/pubsub/examples/keys/README.md
similarity index 97%
rename from source/docs/celix/pubsub/examples/keys/README.md
rename to source/docs/2.2.0/celix/bundles/pubsub/examples/keys/README.md
index ee1300e..bd0812f 100644
--- a/source/docs/celix/pubsub/examples/keys/README.md
+++ b/source/docs/2.2.0/celix/bundles/pubsub/examples/keys/README.md
@@ -1,9 +1,9 @@
---
type: celix-doc
-title: README.md
+title: Pubsub Keys
+version: 2.2.0
---
-
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md b/source/docs/2.2.0/celix/bundles/pubsub/pubsub_admin_udp_mc/README.md
similarity index 87%
rename from source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md
rename to source/docs/2.2.0/celix/bundles/pubsub/pubsub_admin_udp_mc/README.md
index 8fd0ada..bfd5f57 100644
--- a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md
+++ b/source/docs/2.2.0/celix/bundles/pubsub/pubsub_admin_udp_mc/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: PSA UDP Multicast
+version: 2.2.0
---
<!--
@@ -34,7 +35,7 @@ fragments are reassembled at the reception side.
### IP Addresses
-To use UDP-multicast 2 IP adresses are needed:
+To use UDP-multicast 2 IP addresses are needed:
1. IP address which is bound to an (ethernet) interface
2. The multicast address (in the range 224.X.X.X - 239.X.X.X)
@@ -44,7 +45,7 @@ When the PubSubAdmin starts it determines the bound IP address. This is done in
1. The first IP number bound to the interface which is set by the "PSA_INTERFACE" property
2. The interfaces are iterated and the first IP number found is used. (typically this is 127.0.0.1 (localhost)
-The Multicass IP address is determined in the order:
+The multicast IP address is determined in the order:
1. If the `PSA_IP` property is defined, this IP will be used as multicast.
2. If the `PSA_MC_PREFIX` property, is defined, this property is used as the first 2 numbers of the multicast address extended with the last 2 numbers of the bound IP.
@@ -55,7 +56,7 @@ The Multicass IP address is determined in the order:
When a publisher request for a topic a TopicSender is created by a ServiceFactory. This TopicSender uses the multicast address as described above with a random chosen portnumber. The combination of the multicast-IP address with the portnumber and protocol(udp) is the endpoint.
This endpoint is published by the PubSubDiscovery within its topic in ETCD (i.e. udp://224.100.10.20:40123).
-A subscriber, interested in the topic, is informed by the the ToplogyManager that there is a new endpoint. The TopicReceiver at the subscriber side creates a listening socket based on this endpoint.
+A subscriber, interested in the topic, is informed by the the TopologyManager that there is a new endpoint. The TopicReceiver at the subscriber side creates a listening socket based on this endpoint.
Now a data-connection is created and data send by the publisher will be received by the subscriber.
@@ -75,8 +76,8 @@ Now a data-connection is created and data send by the publisher will be received
## Shortcomings
1. Per topic a random portnr is used for creating an endpoint. It is theoretical possible that for 2 topic the same endpoint is created.
-2. For every message a 32 bit random message ID is generated to discriminate segments of different messages which could be sent at the same time. It is theoretically possible that there are 2 equal message ID's at the same time. But since the mesage ID is valid only during the transmission of a message (maximum some milliseconds with large messages) this is not very plausible.
-3. When sending large messages, these messages are segmented and sent after each other. This could cause UDP-buffer overflows in the kernel. A solution could be to add a delay between sending of the segements but this will introduce extra latency.
+2. For every message a 32 bit random message ID is generated to discriminate segments of different messages which could be sent at the same time. It is theoretically possible that there are 2 equal message ID's at the same time. But since the message ID is valid only during the transmission of a message (maximum some milliseconds with large messages) this is not very plausible.
+3. When sending large messages, these messages are segmented and sent after each other. This could cause UDP-buffer overflows in the kernel. A solution could be to add a delay between sending of the segments but this will introduce extra latency.
4. A Hash is created, using the message definition, to identify the message type. When 2 messages generate the same hash something will terribly go wrong. A check should be added to prevent this (or another way to identify the message type). This problem is also valid for the other admins.
diff --git a/source/docs/celix/remote_services/README.md b/source/docs/2.2.0/celix/bundles/remote_services/README.md
similarity index 76%
rename from source/docs/celix/remote_services/README.md
rename to source/docs/2.2.0/celix/bundles/remote_services/README.md
index 33c9d6c..07e73c3 100644
--- a/source/docs/celix/remote_services/README.md
+++ b/source/docs/2.2.0/celix/bundles/remote_services/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Remote Service Admin Service
+version: 2.2.0
---
<!--
@@ -20,8 +21,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-Title: Apache Celix Remote Service Admin Service
-
## Introduction
The Remote Service Admin Service subproject contains an adapted implementation of the OSGi Enterprise Remote Service Admin Service Specification. The subproject consists of three parts, each described in more detail in the following sections.
@@ -85,6 +84,7 @@ Provides a service discovery with preconfigured discovery endpoints, allowing a
|--|--|
| **Configuration** | `DISCOVERY_CFG_POLL_ENDPOINTS`: defines a comma-separated list of discovery endpoints that should be used to query for remote services. Defaults to `http://localhost:9999/org.apache.celix.discovery.configured`; |
| | `DISCOVERY_CFG_POLL_INTERVAL`: defines the interval (in seconds) in which the discovery endpoints should be polled. Defaults to `10` seconds. |
+| | `DISCOVERY_CFG_POLL_TIMEOUT`: defines the maximum time (in seconds) a request of the discovery endpoint poller may take. Defaults to `10` seconds. |
| | `DISCOVERY_CFG_SERVER_PORT`: defines the port on which the HTTP server should listen for incoming requests from other configured discovery endpoints. Defaults to port `9999`; |
| | `DISCOVERY_CFG_SERVER_PATH`: defines the path on which the HTTP server should accept requests from other configured discovery endpoints. Defaults to `/org.apache.celix.discovery.configured`. |
@@ -96,7 +96,7 @@ See [etcd discovery](discovery_etcd/README.html)
| **Bundle** | `discovery_etcd.zip` |
-Provides a service discovery using etcd distributd key/value store.
+Provides a service discovery using etcd distributed key/value store.
See [etcd discovery](discovery_etcd/README.html)
@@ -106,17 +106,13 @@ To develop for the Remote Service Admin implementation of Celix, one needs the f
1. A service **interface**, describes the actual service and methods[^1] that can be called. The service interface is needed at development time to allow a consistent definition;
2. A service **implementation**, when exporting it as remote service. A service endpoint is needed to delegate remote requests to your service implementation;
-3. A service **endpoint**, which will be installed by Celix when exporting a local service. The endpoint is responsible for calling the actual Celix service. Endpoint bundles are not needed when *only* importing services in Celix;
-4. A service **proxy**, which will be installed by Celix when importing a remote service. The proxy is responsible for marshalling and unmarshalling method invocations. Proxy bundles are not needed when *only* exposing services from Celix;
-5. A service **client** or user, which invokes methods on the local or remote service. The client is oblivious to the fact whether the service is running locally or remote.
+3. A service **client** or user, which invokes methods on the local or remote service. The client is oblivious to the fact whether the service is running locally or remote.
The Celix source repository provides a simple calculator example that shows all of the described parts:
-1. [The calculator service interface](http://svn.apache.org/repos/asf/celix/trunk/remote_services/calculator_service/public/include/calculator_service.h), providing three methods: one for adding two numbers, one for subtracting two numbers, and lastly, a method that calculates the square root of a number;
-2. [A calculator service implementation](http://svn.apache.org/repos/asf/celix/trunk/remote_services/calculator_service/private/src/calculator_impl.c) that simply implements the three previously described functions. To mark this service as "remote service", you need to add the `service.exported.interfaces` service property to its service registration. This way, the RSA implementation can expose it as remote service to others;
-3. [A service endpoint](http://svn.apache.org/repos/asf/celix/trunk/remote_services/calculator_endpoint/private/src/calculator_endpoint_impl.c), which is called by the RSA implementation to delegate a method invocation to an actual method in the service implementation. The service endpoint should be registered as `remote_endpoint` service, along with the `remote.interface` service property denoting which service interface this endpoint is capable of handling;
-4. [A service proxy (factory)](http://svn.apache.org/repos/asf/celix/trunk/remote_services/calculator_proxy/private/src/calculator_proxy_impl.c), called by the service client when it wants to invoke a method on a remoted service. The service proxy should be registered as `remote_proxy_factory` service along with the `proxy.interface` service property denoting which service interface the service proxy is capable of handling;
-5. [A service client](http://svn.apache.org/repos/asf/celix/trunk/remote_services/calculator_shell/private/src/add_command.c), that exposes the three calculator methods to as Celix shell commands. The implementation simply retrieves the calculator service as it would do with any other Celix service.
+1. [The calculator service interface](https://github.com/apache/celix/blob/develop/bundles/remote_services/examples/calculator_api/include/calculator_service.h), providing three methods: one for adding two numbers, one for subtracting two numbers, and lastly, a method that calculates the square root of a number;
+2. [A calculator service implementation](https://github.com/apache/celix/blob/develop/bundles/remote_services/examples/calculator_service/src/calculator_impl.c) that simply implements the three previously described functions. To mark this service as "remote service", you need to add the `service.exported.interfaces` service property to its service registration. This way, the RSA implementation can expose it as remote service to others;
+3. [A service client](https://github.com/apache/celix/blob/develop/bundles/remote_services/examples/calculator_shell/src/add_command.c), that exposes the three calculator methods to as Celix shell commands. The implementation simply retrieves the calculator service as it would do with any other Celix service.
If you have access to the Celix source repository, you can run the calculator example using various discovery implementations by invoking the `deploy` target. You can find the example deployments in the `CELIX_BUILD/deploy` directory. For example, to run the calculator example using the configured discovery mechanism, you should open two terminals. In the first terminal, type:
@@ -165,6 +161,15 @@ Also the following libraries are required for building and/or using the Remote S
- Jansson (build and runtime)
- cURL (build and runtime)
+## RSA Bundles
+
+* [Remote Service Admin DFI](remote_service_admin_dfi) - A Dynamic Function Interface (DFI) implementation of the RSA.
+* [Remote Service Admin SHM](remote_service_admin_shm) - A shared memory implementation of the RSA.
+* [Topology Manager](topology_manager) - A (scoped) RSA Topology Manager implementation.
+* [Discovery Configured](discovery_configured) - A RSA Discovery implementation using static configuration (xml).
+* [Discovery Etcd](discovery_etcd/README.html) - A RSA Discovery implementation using etcd.
+* [Discovery SHM](discovery_shm) - A RSA Discovery implementation using shared memory.
+
## Notes
diff --git a/source/docs/celix/remote_services/discovery_etcd/README.md b/source/docs/2.2.0/celix/bundles/remote_services/discovery_etcd/README.md
similarity index 55%
rename from source/docs/celix/remote_services/discovery_etcd/README.md
rename to source/docs/2.2.0/celix/bundles/remote_services/discovery_etcd/README.md
index 6ea6f7a..1ca9d04 100644
--- a/source/docs/celix/remote_services/discovery_etcd/README.md
+++ b/source/docs/2.2.0/celix/bundles/remote_services/discovery_etcd/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Discovery ETCD
+version: 2.2.0
---
<!--
@@ -25,10 +26,14 @@ limitations under the License.
The Celix Discovery ETCD bundles realizes OSGi services discovery based on [etcd](https://github.com/coreos/etcd).
###### Properties
- DISCOVERY_ETCD_ROOT_PATH used path (default: discovery)
- DEFAULT_ETCD_SERVER_IP ip address of the etcd server (default: 127.0.0.1)
- DEFAULT_ETCD_SERVER_PORT port of the etcd server (default: 2379)
- DEFAULT_ETCD_TTL time-to-live for etcd entries in seconds (default: 30)
+ DISCOVERY_ETCD_ROOT_PATH Used path to announce and find discovery entpoints (default: discovery)
+ DISCOVERY_ETCD_SERVER_IP ip address of the etcd server (default: 127.0.0.1)
+ DISCOVERY_ETCD_SERVER_PORT port of the etcd server (default: 2379)
+ DISCOVERY_ETCD_TTL time-to-live for etcd entries in seconds (default: 30)
+
+ DISCOVERY_CFG_SERVER_IP The host to use/announce for this framewokr discovery endpoint. Default "127.0.0.1"
+ DISCOVERY_CFG_SERVER_PORT The port to use/announce for this framework endpoint endpoint. Default 9999
+ DISCOVERY_CFG_SERVER_PATH The path to use for this framework discovery endpoint.Default "/org.apache.celix.discovery.etcd"
###### CMake option
BUILD_RSA_DISCOVERY_ETCD=ON
diff --git a/source/docs/2.2.0/celix/bundles/remote_services/remote_service_admin_dfi/README.md b/source/docs/2.2.0/celix/bundles/remote_services/remote_service_admin_dfi/README.md
new file mode 100644
index 0000000..c729388
--- /dev/null
+++ b/source/docs/2.2.0/celix/bundles/remote_services/remote_service_admin_dfi/README.md
@@ -0,0 +1,39 @@
+---
+type: celix-doc
+title: Remote Service Admin DFI
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+## Remote Service Admin DFI
+
+The Celix Remote Service Admin DFI bundle realizes OSGi remote service using HTTP and JSON.
+The serialization is done using libdfi to json.
+Libffi is configured using descriptor files in the bundles.
+
+###### Properties
+ RSA_PORT The RSA HTTP port to use (default 8888)
+ RSA_IP The RSA ip address to use for discovery (default 127.0.0.1)
+ RSA_INTERFACE If specified, the ip adress of interface (i.g. eth0) will be used.
+
+ RSA_LOG_CALLS If set to true, the RSA will Log calls info (including serialized data) to the file in RSA_LOG_CALLS_FILE. Default is false.
+ RSA_LOG_CALLS_FILE If RSA_LOG_CALLS is enabled to file to log to (starting rsa will truncate file). Default is stdout.
+
+###### CMake option
+ RSA_REMOTE_SERVICE_ADMIN_DFI=ON
diff --git a/source/docs/celix/remote_services/remote_service_admin/README.md b/source/docs/2.2.0/celix/bundles/remote_services/remote_services_api/README.md
similarity index 50%
copy from source/docs/celix/remote_services/remote_service_admin/README.md
copy to source/docs/2.2.0/celix/bundles/remote_services/remote_services_api/README.md
index f620015..6711efa 100644
--- a/source/docs/celix/remote_services/remote_service_admin/README.md
+++ b/source/docs/2.2.0/celix/bundles/remote_services/remote_services_api/README.md
@@ -1,33 +1,17 @@
---
type: celix-doc
-title: README.md
+title: Remote Service Admin
+version: 2.2.0
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-## Remote Service Admin
+# Remote Service Admin
The Remote Service Admin (RSA) provides the mechanisms to import and export services when instructed to do so by the Topology Manager.
-To delegate method calls to the actual service implementation, the RSA_SHM and the RSA_HTTP are using "endpoint/proxy" bundles, which has all the knowledge about the marshalling and unmarshalling of data for the service. The RSA_DFI implementation combines a [foreign function interface](https://en.wikipedia.org/wiki/Foreign_function_interface) technique together with manualy created descriptors.
+To delegate method calls to the actual service implementation, the RSA_SHM and the RSA_HTTP are using "endpoint/proxy" bundles, which has all the knowledge about the marshalling and unmarshalling of data for the service. The RSA_DFI implementation combines a [foreign function interface](https://en.wikipedia.org/wiki/Foreign_function_interface) technique together with manually created descriptors.
Note that this folder contains code commonly used by the RSA implementations and therefore does not include any CMAKE configuration.
-###### Properties
+## Properties
ENDPOINTS defines the relative directory where endpoints and proxys can be found (default: endpoints)
CELIX_FRAMEWORK_EXTENDER_PATH Used in RSA_DFI only. Can be used to define a path to use as an extender path point for the framework bundle. For normal bundles the bundle cache is used.
diff --git a/source/docs/celix/remote_services/remote_service_admin/README.md b/source/docs/2.2.0/celix/bundles/remote_services/rsa_spi/README.md
similarity index 50%
rename from source/docs/celix/remote_services/remote_service_admin/README.md
rename to source/docs/2.2.0/celix/bundles/remote_services/rsa_spi/README.md
index f620015..6711efa 100644
--- a/source/docs/celix/remote_services/remote_service_admin/README.md
+++ b/source/docs/2.2.0/celix/bundles/remote_services/rsa_spi/README.md
@@ -1,33 +1,17 @@
---
type: celix-doc
-title: README.md
+title: Remote Service Admin
+version: 2.2.0
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-## Remote Service Admin
+# Remote Service Admin
The Remote Service Admin (RSA) provides the mechanisms to import and export services when instructed to do so by the Topology Manager.
-To delegate method calls to the actual service implementation, the RSA_SHM and the RSA_HTTP are using "endpoint/proxy" bundles, which has all the knowledge about the marshalling and unmarshalling of data for the service. The RSA_DFI implementation combines a [foreign function interface](https://en.wikipedia.org/wiki/Foreign_function_interface) technique together with manualy created descriptors.
+To delegate method calls to the actual service implementation, the RSA_SHM and the RSA_HTTP are using "endpoint/proxy" bundles, which has all the knowledge about the marshalling and unmarshalling of data for the service. The RSA_DFI implementation combines a [foreign function interface](https://en.wikipedia.org/wiki/Foreign_function_interface) technique together with manually created descriptors.
Note that this folder contains code commonly used by the RSA implementations and therefore does not include any CMAKE configuration.
-###### Properties
+## Properties
ENDPOINTS defines the relative directory where endpoints and proxys can be found (default: endpoints)
CELIX_FRAMEWORK_EXTENDER_PATH Used in RSA_DFI only. Can be used to define a path to use as an extender path point for the framework bundle. For normal bundles the bundle cache is used.
diff --git a/source/docs/celix/remote_services/topology_manager/README.md b/source/docs/2.2.0/celix/bundles/remote_services/topology_manager/README.md
similarity index 96%
rename from source/docs/celix/remote_services/topology_manager/README.md
rename to source/docs/2.2.0/celix/bundles/remote_services/topology_manager/README.md
index f75059c..3665ec0 100644
--- a/source/docs/celix/remote_services/topology_manager/README.md
+++ b/source/docs/2.2.0/celix/bundles/remote_services/topology_manager/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Topology Manager
+version: 2.2.0
---
<!--
diff --git a/source/docs/celix/remote_shell/README.md b/source/docs/2.2.0/celix/bundles/shell/remote_shell/README.md
similarity index 96%
rename from source/docs/celix/remote_shell/README.md
rename to source/docs/2.2.0/celix/bundles/shell/remote_shell/README.md
index bf1eb8a..bfd6064 100644
--- a/source/docs/celix/remote_shell/README.md
+++ b/source/docs/2.2.0/celix/bundles/shell/remote_shell/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Remote Shell
+version: 2.2.0
---
<!--
diff --git a/source/docs/celix/shell/README.md b/source/docs/2.2.0/celix/bundles/shell/shell/README.md
similarity index 85%
rename from source/docs/celix/shell/README.md
rename to source/docs/2.2.0/celix/bundles/shell/shell/README.md
index e680d92..44e1b15 100644
--- a/source/docs/celix/shell/README.md
+++ b/source/docs/2.2.0/celix/bundles/shell/shell/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Shell
+version: 2.2.0
---
<!--
@@ -41,10 +42,16 @@ While the shell can be extended with additional commands by other bundles, it al
Further information about a command can be retrieved by using `help` combined with the command.
+## CMake options
+ BUILD_SHELL=ON
+
## Shell Config Options
-- SHELL_USE_ANSI_COLORS - Wether shell command are allowed to use
+- SHELL_USE_ANSI_COLORS - Whether shell command are allowed to use
ANSI colors when printing info. default is true.
-## CMake options
- BUILD_SHELL=ON
+## Using info
+
+If the Celix Shell is installed, 'find_package(Celix)' will set:
+ - The `Celix::shell_api` interface (i.e. header only) library target
+ - The `Celix::shell` bundle target
diff --git a/source/docs/celix/shell_tui/README.md b/source/docs/2.2.0/celix/bundles/shell/shell_tui/README.md
similarity index 81%
copy from source/docs/celix/shell_tui/README.md
copy to source/docs/2.2.0/celix/bundles/shell/shell_tui/README.md
index 559004c..8f13343 100644
--- a/source/docs/celix/shell_tui/README.md
+++ b/source/docs/2.2.0/celix/bundles/shell/shell_tui/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Shell TUI
+version: 2.2.0
---
<!--
@@ -29,6 +30,11 @@ The Celix Shell TUI implements a textual user interface for the Celix Shell.
## Config options
-- SHELL_USE_ANSI_CONTROL_SEQUENCES - Wether to use ANSI control
+- SHELL_USE_ANSI_CONTROL_SEQUENCES - Whether to use ANSI control
sequences to support backspace, left, up, etc key commands in the
shell tui. Default is true if a TERM environment is set else false.
+
+## Using info
+
+If the Celix Shell TUI is installed, 'find_package(Celix)' will set:
+ - The `Celix::shell_tui` bundle target if the shell_tui is installed
diff --git a/source/docs/celix/shell_tui/README.md b/source/docs/2.2.0/celix/bundles/shell/shell_wui/README.md
similarity index 71%
copy from source/docs/celix/shell_tui/README.md
copy to source/docs/2.2.0/celix/bundles/shell/shell_wui/README.md
index 559004c..34de21b 100644
--- a/source/docs/celix/shell_tui/README.md
+++ b/source/docs/2.2.0/celix/bundles/shell/shell_wui/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Shell WUI
+version: 2.2.0
---
<!--
@@ -20,15 +21,18 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-# Shell TUI
+# Shell WUI
-The Celix Shell TUI implements a textual user interface for the Celix Shell.
+The Celix Shell Web User Interface implements a web based user interface for the Celix Shell.
## CMake option
- BUILD_SHELL_TUI=ON
+ BUILD_SHELL_WUI=ON
## Config options
-- SHELL_USE_ANSI_CONTROL_SEQUENCES - Wether to use ANSI control
-sequences to support backspace, left, up, etc key commands in the
-shell tui. Default is true if a TERM environment is set else false.
+N/A
+
+## Using info
+
+If the Celix Shell WUI is installed, 'find_package(Celix)' will set:
+ - The `Celix::shell_wui` bundle target if the shell_wui is installed
diff --git a/source/docs/celix/documents/building/readme.md b/source/docs/2.2.0/celix/documents/building/README.md
similarity index 84%
rename from source/docs/celix/documents/building/readme.md
rename to source/docs/2.2.0/celix/documents/building/README.md
index 3d914e1..c5e3a8c 100644
--- a/source/docs/celix/documents/building/readme.md
+++ b/source/docs/2.2.0/celix/documents/building/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Building and Installing
+version: 2.2.0
---
<!--
@@ -25,28 +26,30 @@ Apache Celix aims to be support a broad range of UNIX platforms.
Currently the [continuous integration build server](https://travis-ci.org/apache/celix) builds and tests Apache Celix for:
-* Ubuntu Trusty Tahr (14.04)
+* Ubuntu Trusty Tahr (14.04)
* GCC
* CLang
-* OSX
+* OSX
* GCC
* CLang
-* Android (cross-compiled on Ubuntu Trusty Tahr)
+* Android (cross-compiled on Ubuntu Trusty Tahr)
* GCC
# Preparing
The following packages (libraries + headers) should be installed on your system:
-* Development Environment
- * build-essentials (gcc/g++ or clang/clang++)
- * git
- * java (for packaging bundles)
- * cmake (3.2 or higher)
-* Apache Celix Dependencies
- * curl
- * jansson
- * libffi
- * libxml2 (for remote services and bonjour shell)
+* Development Environment
+ * build-essentials (gcc/g++ or clang/clang++)
+ * git
+ * java (for packaging bundles)
+ * make (3.2 or higher)
+* Apache Celix Dependencies
+ * zlib
+ * uuid
+ * curl (only initialized in the Celix framework)
+ * jansson (for serialization in libdfi)
+ * libffi (for libdfi)
+ * libxml2 (for remote services and bonjour shell)
For debian based systems (apt), the following command should work:
@@ -133,11 +136,11 @@ sudo make install
## Running Apache Celix
-If Apache Celix is succesfully installed running
+If Apache Celix is successfully installed running
```bash
celix
```
should give the following output:
"Error: invalid or non-existing configuration file: 'config.properties'.No such file or directory".
-For more info how to build your own projects and/or running the Apache Celix examples see [Getting Started](../getting_started/readme.html).
+For more info how to build your own projects and/or running the Apache Celix examples see [Getting Started](../getting_started/README.html).
diff --git a/source/docs/2.2.0/celix/documents/cmake_commands/README.md b/source/docs/2.2.0/celix/documents/cmake_commands/README.md
new file mode 100644
index 0000000..6f8af7d
--- /dev/null
+++ b/source/docs/2.2.0/celix/documents/cmake_commands/README.md
@@ -0,0 +1,513 @@
+---
+type: celix-doc
+title: CMake Commands
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Apache Celix - CMake Commands
+
+For Apache Celix several cmake command are added to be able to work with Apache Celix bundles and deployments.
+
+# Bundles
+
+## add_celix_bundle
+Add a Celix bundle to the project. There are three variants:
+- With SOURCES the bundle will be created using a list of sources files as input for the bundle activator library.
+- With ACTIVATOR the bundle will be created using the library target or absolute path to existing library as activator library.
+- With the NO_ACTIVATOR option will create a bundle without a activator (i.e. a pure resource bundle).
+
+Optional arguments are:
+- NAME: The (human readable) name of the bundle. This will be used as Bundle-Name manifest entry. Default is the <bundle_target_name>.
+- SYMBOLIC_NAME: The symbolic name of the bundle. This will be used as Bundle-SymbolicName manifest entry. Default is the <bundle_target_name>.
+- DESCRIPTION: The description of the bundle. This will be used as Bundle-Description manifest entry. Default this is empty.
+- GROUP: The group the bundle is part of. This will be used as Bundle-Group manifest entry. Default this is empty (no group).
+- VERSION: The bundle version. This will be used for the Bundle-Version manifest entry. In combination with SOURCES the version will also be used to set the activator library target property VERSION and SOVERSION.
+ For SOVERSION only the major part is used. Expected scheme is "<major>.<minor>.<path>". Default version is "0.0.0"
+- FILENAME: The filename of the bundle file. Default is <bundle_target_name>.zip.
+- PRIVATE_LIBRARIES: private libraries to be included in the bundle. Specified libraries are added to the "Private-Library" manifest statement and added in the root of the bundle. libraries can be cmake library targets or absolute paths to existing libraries.
+- HEADERS: Additional headers values that are appended to the bundle manifest.
+
+```CMake
+add_celix_bundle(<bundle_target_name>
+ SOURCES source1 source2 ...
+ [NAME bundle_name]
+ [SYMBOLIC_NAME bundle_symbolic_name]
+ [DESCRIPTION bundle_description]
+ [GROUP bundle_group]
+ [VERSION bundle_version]
+ [FILENAME bundle_filename]
+ [PRIVATE_LIBRARIES private_lib1 private_lib2 ...]
+ [HEADERS "header1: header1_value" "header2: header2_value" ...]
+)
+```
+
+```CMake
+add_celix_bundle(<bundle_target_name>
+ ACTIVATOR <activator_lib>
+ [NAME bundle_name]
+ [SYMBOLIC_NAME bundle_symbolic_name]
+ [DESCRIPTION bundle_description]
+ [GROUP bundle_group]
+ [VERSION bundle_version]
+ [FILENAME bundle_filename]
+ [PRIVATE_LIBRARIES private_lib1 private_lib2 ...]
+ [HEADERS "header1: header1_value" "header2: header2_value" ...]
+)
+```
+
+```CMake
+add_celix_bundle(<bundle_target_name>
+ NO_ACTIVATOR
+ [NAME bundle_name]
+ [SYMBOLIC_NAME bundle_symbolic_name]
+ [DESCRIPTION bundle_description]
+ [GROUP bundle_group]
+ [VERSION bundle_version]
+ [FILENAME bundle_filename]
+ [PRIVATE_LIBRARIES private_lib1 private_lib2 ...]
+ [HEADERS "header1: header1_value" "header2: header2_value" ...]
+)
+```
+
+## celix_bundle_private_libs
+Add libraries to a bundle. The libraries should be cmake library targets or an absolute path to an existing library.
+
+The libraries will be copied into the bundle zip and activator library will be linked (PRIVATE) against them.
+
+```CMake
+celix_bundle_private_libs(<bundle_target>
+ lib1 lib2 ...
+)
+```
+
+## celix_bundle_files
+Add files to the target bundle. DESTINATION is relative to the bundle archive root.
+The rest of the command is conform file(COPY ...) cmake command.
+See cmake file(COPY ...) command for more info.
+
+Note with celix_bundle_files files are copied cmake generation time.
+Updates are not copied !
+
+```CMake
+celix_bundle_files(<bundle_target>
+ files... DESTINATION <dir>
+ [FILE_PERMISSIONS permissions...]
+ [DIRECTORY_PERMISSIONS permissions...]
+ [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]
+ [FILES_MATCHING]
+ [ [PATTERN <pattern> | REGEX <regex>]
+ [EXCLUDE] [PERMISSIONS permissions...] ]
+ [...]
+)
+```
+
+
+## celix_bundle_headers
+Append the provided headers to the target bundle manifest.
+
+```CMake
+celix_bundle_headers(<bundle_target>
+ "header1: header1_value"
+ "header2: header2_value"
+ ...
+)
+```
+
+## celix_bundle_symbolic_name
+Set bundle symbolic name
+
+```CMake
+celix_bundle_symbolic_name(<bundle_target> symbolic_name)
+```
+
+## celix_bundle_name
+Set bundle name
+
+```CMake
+celix_bundle_name(<bundle_target> name)
+```
+
+## celix_bundle_version
+Set bundle version
+
+```CMake
+celix_bundle_version(<bundle_target> version)
+```
+
+## celix_bundle_description
+Set bundle description
+
+```CMake
+celix_bundle_description(<bundle_target> description)
+```
+
+## celix_bundle_group
+Set bundle group.
+
+```CMake
+celix_bundle_group(<bundle_target> bundle group)
+```
+
+## install_celix_bundle
+Install bundle when 'make install' is executed.
+Bundles are installed at `<install-prefix>/share/<project_name>/bundles`.
+Headers are installed at `<install-prefix>/include/<project_name>/<bundle_name>`
+Resources are installed at `<install-prefix>/shared/<project_name>/<bundle_name>`
+
+Optional arguments:
+- EXPORT: Associates the installed bundle with a export_name.
+ The export name can be used to generate a Celix Targets cmake file (see install_celix_bundle_targets)
+- PROJECT_NAME: The project name for installing. Default is the cmake project name.
+- BUNDLE_NAME: The bundle name used when installing headers/resources. Default is the bundle target name.
+- HEADERS: A list of headers to install for the bundle.
+- RESOURCES: A list of resources to install for the bundle.
+
+```CMake
+install_celix_bundle(<bundle_target>
+ [EXPORT] export_name
+ [PROJECT_NAME] project_name
+ [BUNDLE_NAME] bundle_name
+ [HEADERS header_file1 header_file2 ...]
+ [RESOURCES resource1 resource2 ...]
+)
+```
+
+## install_celix_targets
+Generate and install a Celix Targets cmake file which contains CMake commands to create imported targets for the bundles
+install using the provided <export_name>. These imported CMake targets can be used in in CMake project using the installed
+bundles.
+
+Optional Arguments:
+- FILE: The Celix Targets cmake filename to used. Default is <export_name>BundleTargets.cmake
+- PROJECT_NAME: The project name to used for the share location. Default is the cmake project name.
+- DESTINATION: The (relative) location to install the Celix Targets cmake file to. Default is share/<PROJECT_NAME>/cmake.
+
+```CMake
+install_celix_targets(<export_name>
+ NAMESPACE <namespace>
+ [FILE <celix_target_filename>]
+ [PROJECT_NAME <project_name>]
+ [DESTINATION <celix_targets_destination>]
+)
+```
+
+Example:
+```CMake
+install_celix_targets(celix NAMESPACE Celix:: DESTINATION share/celix/cmake FILE CelixTargets.cmake)
+```
+
+
+
+
+
+# Celix Containers
+The 'add_celix_container' Celix CMake command can be used to create Celix containers.
+Celix containers are executables preconfigured with configuration properties and bundles to run.
+
+## add_celix_container
+Add a Celix container, consisting out of a selection of bundles and a Celix launcher.
+Celix containers can be used to run/test a selection of bundles in the celix framework.
+A Celix container will be build in `<cmake_build_dir>/deploy[/<group_name>]/<celix_container_name>`.
+Use the `<celix_container_name>` executable to run the containers.
+
+There are three variants of 'add_celix_container':
+- If no launcher is specified a custom Celix launcher will be generated. This launcher also contains the configured properties.
+- If a LAUNCHER_SRC is provided a Celix launcher will be build using the provided sources. Additional sources can be added with the
+ CMake 'target_sources' command.
+- If a LAUNCHER (absolute path to a executable of CMake `add_executable` target) is provided that will be used as Celix launcher.
+
+Creating a Celix containers using 'add_celix_container' will lead to a CMake executable target (expect if a LAUNCHER is used).
+These targets can be used to run/debug Celix containers from a IDE (if the IDE supports CMake).
+
+Optional Arguments:
+- COPY: With this option the used bundles are copied to the container build dir in the 'bundles' dir.
+ A additional result of this is that the configured references to the bundles are then relative instead of absolute.
+- CXX: With this option the generated Celix launcher (if used) will be a C++ source instead of a C source.
+ A additional result of this is that Celix launcher is also linked against stdlibc++.
+- USE_CONFIG: With this option config properties are generated in a 'config.properties' instead of embedded in the Celix launcher.
+- GROUP: If configured the build location will be prefixed the GROUP. Default is empty.
+- NAME: The name of the executable. Default is <celix_container_name>. Only useful for generated/LAUNCHER_SRC Celix launchers.
+- DIR: The base build directory of the Celix container. Default is `<cmake_build_dir>/deploy`.
+- BUNDLES: A list of bundles to configured for the Celix container to install and start.
+ These bundle will be configured for run level 3. See 'celix_container_bundles' for more info.
+- PROPERTIES: A list of configuration properties, these can be used to configure the Celix framework and/or bundles.
+ Normally this will be EMBEDED_PROPERTIES, but if the USE_CONFIG option is used this will be RUNTIME_PROPERTIES.
+ See the framework library or bundles documentation about the available configuration options.
+- EMBEDDED_PROPERTIES: A list of configuration properties which will be used in the generated Celix launcher.
+- RUNTIME_PROPERTIES: A list of configuration properties which will be used in the generated config.properties file.
+
+```CMake
+add_celix_container(<celix_container_name>
+ [COPY]
+ [CXX]
+ [USE_CONFIG]
+ [GROUP group_name]
+ [NAME celix_container_name]
+ [DIR dir]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [EMBEDDED_PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [RUNTIME_PROPERTIES "prop1=val1" "prop2=val2" ...]
+)
+```
+
+```CMake
+add_celix_container(<celix_container_name>
+ LAUNCHER launcher
+ [COPY]
+ [CXX]
+ [USE_CONFIG]
+ [GROUP group_name]
+ [NAME celix_container_name]
+ [DIR dir]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [EMBEDDED_PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [RUNTIME_PROPERTIES "prop1=val1" "prop2=val2" ...]
+)
+```
+
+```CMake
+add_celix_container(<celix_container_name>
+ LAUNCHER_SRC launcher_src
+ [COPY]
+ [CXX]
+ [USE_CONFIG]
+ [GROUP group_name]
+ [NAME celix_container_name]
+ [DIR dir]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [EMBEDDED_PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [RUNTIME_PROPERTIES "prop1=val1" "prop2=val2" ...]
+)
+```
+
+## celix_container_bundles
+Add the selected bundles to the Celix container. These bundles are (if configured) copied to the container build dir and
+are added to the configuration properties so that they are installed and started when the Celix container executed.
+
+The Celix framework support 7 (0 - 6) run levels. Run levels can be used to control the start and stop order of bundles.
+Bundles in run level 0 are started first and bundles in run level 6 are started last.
+When stopping bundles in run level 6 are stopped first and bundles in run level 0 are stopped last.
+Within a run level the order of configured decides the start order; bundles added earlier are started first.
+
+
+Optional Arguments:
+- LEVEL: The run level for the added bundles. Default is 3.
+
+```CMake
+celix_container_bundles(<celix_container_target_name>
+ [LEVEL (0..5)]
+ bundle1
+ bundle2
+ ...
+)
+```
+
+## celix_container_properties
+Add the provided properties to the target Celix container config properties.
+If the USE_CONFIG option is used these configuration properties will be added to the 'config.properties' file else they
+will be added to the generated Celix launcher.
+
+```CMake
+celix_container_properties(<celix_container_target_name>
+ "prop1=val1"
+ "prop2=val2"
+ ...
+)
+```
+
+## celix_container_embedded_properties
+Add the provided properties to the target Celix container config properties.
+These properties will be embedded into the generated Celix launcher.
+
+```CMake
+celix_container_embedded_properties(<celix_container_target_name>
+ "prop1=val1"
+ "prop2=val2"
+ ...
+)
+```
+
+## celix_container_runtime_properties
+Add the provided properties to the target Celix container config properties.
+These properties will be added to the config.properties in the container build dir.
+
+```CMake
+celix_container_runtime_properties(<celix_container_target_name>
+ "prop1=val1"
+ "prop2=val2"
+ ...
+)
+```
+
+
+
+
+
+
+
+
+
+# Celix Docker Images
+The `add_celix_docker` Apache Celix CMake command can be used to create Apache Celix docker directories.
+These directories can be used (with 'docker build' or podman) to create very small Apache Celix docker images.
+
+## add_celix_docker
+Adds a docker target dir, containing a all the required executables,
+libraries, filesystem files and selected bundles needed to run a Apache Celix framework in a docker container.
+
+The 'add_celix_docker' target is a executable target and can be used to link libraries which are needed in the docker image.
+
+The docker dir can be found in `<cmake_build_dir>/docker[/<group_name>]/<docker_name>`.
+
+The docker directories are build with the target `celix-build-docker-dirs`, this does not create the
+docker images and can also be executed on systems without docker. The `celix-build-docker-dirs` is trigger
+with `make all`.
+
+The docker images are build with the target `celix-build-docker-images`. For this to work docker needs te installed
+and the user executing the `celix-build-docker-images` should have right to create docker images.
+The `celix-build-docker-images` is not triggered with `make all`
+
+There are three variants of 'add_celix_docker':
+- If no launcher is specified a custom Celix launcher will be generated. This launcher also contains the configured properties.
+- If a LAUNCHER_SRC is provided a Celix launcher will be build using the provided sources. Additional sources can be added with the
+ CMake 'target_sources' command.
+- If a LAUNCHER (absolute path to a executable of CMake `add_executable` target) is provided that will be used as Celix launcher.
+
+Optional arguments:
+- CXX: With this option the generated Celix launcher (if used) will be a C++ source instead of a C source.
+ A additional result of this is that Celix launcher is also linked against stdlibc++.
+- GROUP: If configured the build location will be prefixed the GROUP. Default is empty.
+- NAME: The name of the executable. Default is <docker_target_name>. Only useful for generated/LAUNCHER_SRC Celix launchers.
+- FROM: Configured the docker image base. Default is scratch.
+ If configured a minimal filesystem will not be created!
+- BUNDLES_DIR: Configures the directory where are all the bundles are copied. Default is /bundles.
+- WORKDIR: Configures the workdir of the docker image. Default is /root.
+- IMAGE_NAME: Configure the image name. Default is NAME.
+- BUNDLES: Configures the used bundles. These bundles are configured for run level 3. see 'celix_docker_bundles' for more info.
+- PROPERTIES: Configure configuration properties.
+- INSTRUCTIONS: Additional dockker instruction to add the the generated Dockerfile.
+
+```CMake
+add_celix_docker(<docker_target_name>
+ [CXX]
+ [GROUP group_name]
+ [NAME deploy_name]
+ [FROM docker_from_image]
+ [BUNDLES_DIR bundle_dir_in_docker_image]
+ [WORKDIR workdir_in_docker_image]
+ [IMAGE_NAME docker_image_name]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [INSTRUCTIONS "instr1" "instr2" ...]
+)
+```
+
+```CMake
+add_celix_docker(<docker_target_name>
+ LAUNCHER_SRC launcher_src
+ [CXX]
+ [GROUP group_name]
+ [NAME deploy_name]
+ [FROM docker_from_image]
+ [BUNDLES_DIR bundle_dir_in_docker_image]
+ [WORKDIR workdir_in_docker_image]
+ [IMAGE_NAME docker_image_name]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [INSTRUCTIONS "instr1" "instr2" ...]
+)
+```
+
+```CMake
+add_celix_docker(<docker_target_name>
+ LAUNCHER launcher
+ [CXX]
+ [GROUP group_name]
+ [NAME deploy_name]
+ [FROM docker_from_image]
+ [BUNDLES_DIR bundle_dir_in_docker_image]
+ [WORKDIR workdir_in_docker_image]
+ [IMAGE_NAME docker_image_name]
+ [BUNDLES <bundle1> <bundle2> ...]
+ [PROPERTIES "prop1=val1" "prop2=val2" ...]
+ [INSTRUCTIONS "instr1" "instr2" ...]
+)
+```
+
+## celix_docker_bundles
+Add the selected bundles to the Celix docker image. These bundles are copied to the docker build dir and
+are added to the configuration properties so that they are installed and started when the Celix docker container is created and started.
+
+The Celix framework support 7 (0 - 6) run levels. Run levels can be used to control the start and stop order of bundles.
+Bundles in run level 0 are started first and bundles in run level 6 are started last.
+When stopping bundles in run level 6 are stopped first and bundles in run level 0 are stopped last.
+Within a run level the order of configured decides the start order; bundles added earlier are started first.
+
+
+Optional Arguments:
+- LEVEL: The run level for the added bundles. Default is 3.
+
+```CMake
+celix_docker_bundles(<celix_container_target_name>
+ [LEVEL (0..5)]
+ bundle1
+ bundle2
+ ...
+)
+```
+
+## celix_docker_properties
+Same as `celix_container_properties`, but then for the celix container
+in the docker image.
+
+```CMake
+celix_docker_properties(<docker_target_name>
+ "prop1=val1"
+ "prop2=val2"
+ ...
+)
+```
+
+## celix_docker_embedded_properties
+Same as `celix_container_embedded_properties`, but then for the celix container
+in the docker image.
+
+```CMake
+celix_docker_embedded_properties(<docker_target_name>
+ "prop1=val1"
+ "prop2=val2"
+ ...
+)
+```
+
+## celix_docker_instructions
+Add the provided docker instruction to the end of the generated
+Dockerfile.
+
+```CMake
+celix_docker_instructions(<docker_target_name>
+ "instruction1"
+ "instruction2"
+ ...
+)
+```
diff --git a/source/docs/celix/documents/getting_started/readme.md b/source/docs/2.2.0/celix/documents/getting_started/README.md
similarity index 95%
rename from source/docs/celix/documents/getting_started/readme.md
rename to source/docs/2.2.0/celix/documents/getting_started/README.md
index 93cf78c..1132d4f 100644
--- a/source/docs/celix/documents/getting_started/readme.md
+++ b/source/docs/2.2.0/celix/documents/getting_started/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Getting Started Guide
+version: 2.2.0
---
<!--
@@ -27,6 +28,5 @@ There are several guide to help you get started. The first guide is [Getting Sta
and this should get you started for your first C and/or C++ bundle.
After that you can extend the example by using services with the following guides:
-
- - [Getting Started: Using Services with C](using_services_with_c.html)
- - [Getting Started: Using Services with C++](using_services_with_cxx.html).
+ - [Getting Started: Using Services with C](using_services_with_c.html)
+ - [Getting Started: Using Services with C++](using_services_with_cxx.html)
diff --git a/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md b/source/docs/2.2.0/celix/documents/getting_started/creating_a_simple_bundle.md
similarity index 73%
rename from source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
rename to source/docs/2.2.0/celix/documents/getting_started/creating_a_simple_bundle.md
index faacad7..bc8ea23 100644
--- a/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
+++ b/source/docs/2.2.0/celix/documents/getting_started/creating_a_simple_bundle.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: creating_a_simple_bundle.md
+title: Creating a Simple Bundle
+version: 2.2.0
---
<!--
@@ -31,7 +32,7 @@ If there are any uncertainties or question, don't hesitate to ask your questions
Some experience with a command line interface (xterm) is expected to be able to follow this guide.
## Building and Installing
-For Apache Celix see [Building And Installing](../building/readme.html)
+For Apache Celix see [Building And Installing](../building/README.html)
## Installing Eclipse CDT
Download the latest eclipse CDT at [http://www.eclipse.org](http://www.eclipse.org) and install it on your system. For more information on how the install eclipse on your system consult the eclipse documentation. For this getting started guide the luna version of eclipse was used ([linux](http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/luna/R/eclipse-cpp-luna-R-linux-gtk-x86_64.tar.gz) [mac](http://www.eclipse.org/downloads/download.php?file=/technolo [...]
@@ -70,7 +71,6 @@ SET(CMAKE_CXX_FLAGS_DEBUG "-g -DDEBUG")
#Note. If celix is not installed in /usr/local dir, change the location accordingly.
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/usr/local/share/celix/cmake/modules")
find_package(CELIX REQUIRED)
-include_directories(${CELIX_INCLUDE_DIRS})
#Part 4. Choose C, C++ or both
add_subdirectory(bundles/HelloWorld_c) #C
@@ -89,19 +89,18 @@ This CMakeLists.txt file, sets up the following:
* The Celix package should be searched, configured and that the Celix package is required.
* For all build targets in this CMakeLists.txt file or any sub directory CMakeLists.txt files the Apache Celix headers directory should be included.
* Part 4
- * The CMakelists.txt file in the subdirectory bundles/hello_world and/or bundles/HelloWorld should also be processed.
+ * The CMakelists.txt file in the subdirectory bundles/export_import and/or bundles/HelloWorld should also be processed.
-It is a good practice to create a separate CMakeLists.txt file for every bundle you want to build. For the hello_world bundle a CMakeLists.txt file should be created in the bundles/hello_world sub directory.
+It is a good practice to create a separate CMakeLists.txt file for every bundle you want to build. For the export_import bundle a CMakeLists.txt file should be created in the bundles/export_import sub directory.
Create the sub directory:
-```CMake
-#Create directory structure for the hello_world bundles
+```bash
+# Create directory structure for the hello_world bundles
cd ${WS}/myproject
mkdir -p bundles/HelloWorld_c/src
mkdir -p bundles/HelloWorld_cxx/src
-mkdir -p bundles/HelloWorld_cxx/include
```
@@ -115,12 +114,6 @@ add_celix_bundle(HelloWorld_c
SOURCES
src/HelloWorld_activator.c
)
-
-if(APPLE)
- target_link_libraries(HelloWorld_c ${CELIX_LIBRARIES} -Wl,-all_load ${CELIX_DM_STATIC_LIB})
-else()
- target_link_libraries(HelloWorld_c -Wl,--no-undefined -Wl,--whole-archive ${CELIX_DM_STATIC_LIB} -Wl,--no-whole-archive ${CELIX_LIBRARIES})
-endif()
```
And/or the following CMakeLists.txt for the C++ bundle:
@@ -133,97 +126,70 @@ add_celix_bundle(HelloWorld_cxx
SOURCES
src/HelloWorldActivator.cc
)
-target_include_directories(HelloWorld_cxx PRIVATE include)
-
-IF(APPLE)
- target_link_libraries(HelloWorld_cxx ${CELIX_LIBRARIES} -Wl,-all_load ${CELIX_DM_STATIC_CXX_LIB})
-else()
- target_link_libraries(HelloWorld_cxx -Wl,--no-undefined -Wl,--whole-archive ${CELIX_DM_STATIC_CXX_LIB} -Wl,--no-whole-archive ${CELIX_LIBRARIES})
-endif()
```
-These CMakeLists.txt files declare that the bundles should be build based on the build result (shared library) of the declared sources (in this case the `private/src/hello_world_activator.c` or `private/src/HelloWorldActivator.cc` source).
+These CMakeLists.txt files declare that the bundles should be build based on the build result (shared library) of the declared sources (in this case the `src/hello_world_activator.c` or `src/HelloWorldActivator.cc` source).
The `add_celix_bundle` CMake function is an Apache Celix specific CMake extension.
-The library used for the bundle will also be linked against the dependency manager static library.
-
The Celix framework will install the bundle, load the bundle shared library and call the bundle activator entry symbols. These entries need to be programmed by the user.
-Note that in these examples we use the dependency manager libraries (C and C++ version) instead of developing a "vanilla" bundle activator;
-The dependency manager uses a higher abstraction and is more simple to understand and maintain, but not part of the OSGi standard.
+Note that in these examples we use the CELIX_GEN_BUNDLE_ACTIVATOR and CELIX_GEN_CXX_BUNDLE_ACTIVATOR
+to generate the bundle activator functions (and as result the symbols needed for the Celix framework); although not necessary, this prevents the need for writing some boiler plating code.
The C Bundle Activator:
```C
//${WS}/myproject/bundles/hello_world/src/HelloWorld_activator.c
-#include <stdlib.h>
#include <stdio.h>
+#include <celix_api.h>
-#include "dm_activator.h"
+typedef struct activator_data {
+ /*intentional empty*/
+} activator_data_t;
-struct userData {
- char * word;
-};
-celix_status_t dm_create(bundle_context_pt context, void **out) {
- celix_status_t status = CELIX_SUCCESS;
- struct userData* result = calloc(1, sizeof(*result));
- if (result != NULL) {
- result->word = "C World";
- *out = result;
- } else {
- status = CELIX_START_ERROR;
- }
- return status;
-}
-
-celix_status_t dm_init(void* userData, bundle_context_pt context, dm_dependency_manager_pt manager) {
- struct userData* data = (struct userData *) userData;
- printf("Hello %s\n", data->word);
+static celix_status_t activator_start(activator_data_t *data, celix_bundle_context_t *ctx) {
+ printf("Hello world from C bundle with id %li\n", celix_bundle_getId(celix_bundleContext_getBundle(ctx)));
return CELIX_SUCCESS;
}
-celix_status_t dm_destroy(void* userData, bundle_context_pt context, dm_dependency_manager_pt manager) {
- free(userData);
+static celix_status_t activator_stop(activator_data_t *data, celix_bundle_context_t *ctx) {
+ printf("Goodbye world from C bundle with id %li\n", celix_bundle_getId(celix_bundleContext_getBundle(ctx)));
return CELIX_SUCCESS;
}
+
+CELIX_GEN_BUNDLE_ACTIVATOR(activator_data_t, activator_start, activator_stop)
```
-The C++ Bundle Activator (header + source):
-```C++
-//${WS}/myproject/bundles/HelloWorld/include/HelloWorldActivator.h
-#ifndef HELLOWORLDACTIVATOR_H_
-#define HELLOWORLDACTIVATOR_H_
-
-#include "celix/dm/DmActivator.h"
-
-class HelloWorldActivator : public celix::dm::DmActivator {
-private:
- const std::string word {"C++ World"};
-public:
- HelloWorldActivator(celix::dm::DependencyManager& mng) : DmActivator {mng} {}
- virtual void init();
- virtual void deinit();
-};
-
-#endif //HELLOWORLDACTIVATOR_H_
-```
+The C++ Bundle Activator:
```C++
//${WS}/myproject/bundles/HelloWorld/private/src/HelloWorldActivator.cc
-#include "HelloWorldActivator.h"
+#include <memory>
#include <iostream>
-DmActivator* DmActivator::create(celix::dm::DependencyManager& mng) {
- return new HelloWorldActivator(mng);
-}
+#include <celix_api.h>
-void HelloWorldActivator::init() {
- std::cout << "Hello " << this->word << "\n";
-}
+namespace /*anon*/ {
+
+ class BundleActivator {
+ public:
+ BundleActivator(std::shared_ptr<celix::dm::DependencyManager> _mng) : mng{_mng} {
+ std::cout << "Hello world from C++ bundle with id " << bndId() << std::endl;
+ }
+ ~BundleActivator() {
+ std::cout << "Goodbye world from C++ bundle with id " << bndId() << std::endl;
+ }
+ private:
+ long bndId() const {
+ return celix_bundle_getId(celix_bundleContext_getBundle(mng->bundleContext()));
+ }
+
+ std::shared_ptr<celix::dm::DependencyManager> mng;
+ };
-void HelloWorldActivator::deinit() {
- //nothing to do
}
+
+CELIX_GEN_CXX_BUNDLE_ACTIVATOR(BundleActivator)
```
### Building
@@ -257,9 +223,8 @@ To create a deployment for the hello world bundles two things are needed:
add_celix_container(myproject
CXX
BUNDLES
- ${CELIX_BUNDLES_DIR}/shell.zip
- ${CELIX_BUNDLES_DIR}/shell_tui.zip
- ${CELIX_BUNDLES_DIR}/dm_shell.zip
+ Celix::shell
+ Celix::shell_tui
HelloWorld_c #C bundle
HelloWorld_cxx #C++ bundle
)
@@ -320,20 +285,14 @@ Because CLion is a IDE for CMake projects and Apache Celix projects are CMake pr
To run a Celix container just select the target from CLion and press Run.
-
+
## Next
The get a complete overview of the available Celix CMake commands see:
-
-- [Apache Celix - Celix CMake Commands](../cmake_commands/readme.html)
+ - [Apache Celix - Celix CMake Commands](../cmake_commands/README.html)
The idea behind service oriented programming is that functionality is provided and used by abstract service, which hide implementation details.
For a guide how to provide and use services see
- [Apache Celix - Getting Started Guide: Using Services with C](using_services_with_c.html)
- [Apache Celix - Getting Started Guide: Using Services with C++](using_services_with_cxx.html)
-
-
-
-
-
diff --git a/source/docs/celix/documents/getting_started/using_services_with_c.md b/source/docs/2.2.0/celix/documents/getting_started/using_services_with_c.md
similarity index 98%
rename from source/docs/celix/documents/getting_started/using_services_with_c.md
rename to source/docs/2.2.0/celix/documents/getting_started/using_services_with_c.md
index 7520154..d4d617d 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_c.md
+++ b/source/docs/2.2.0/celix/documents/getting_started/using_services_with_c.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: using_services_with_c.md
+title: Using Services with C
+version: 2.2.0
---
<!--
@@ -115,7 +116,7 @@ The init/deinit function can be used to include (de)initialization which is not
## Code Examples
The next code blocks contains some code examples of components to indicate how to handle service dependencies, how to specify providing services and how to cope with locking/synchronizing.
-The complete example can be found [here](../../examples/services_example_c).
+The complete example can be found [here](../../examples/celix-examples/services_example_c).
The error checking is very minimal in these example to keep the focus on how to interact with services and how to deal with errors in C / Celix.
@@ -612,4 +613,4 @@ The suspend strategy has the advantage of reducing locks' usage: of course, susp
## See also
-See the [C Dependeny Manager](../../dependency_manager/readme.html) and [C Dependency Manager example](../../examples/dm_example) for more information and a more complex working example.
+See the [C Dependency Manager](../../libs/dependency_manager/README.html) and [C Dependency Manager example](../../examples/celix-examples/dm_example) for more information and a more complex working example.
diff --git a/source/docs/celix/documents/getting_started/using_services_with_cxx.md b/source/docs/2.2.0/celix/documents/getting_started/using_services_with_cxx.md
similarity index 89%
rename from source/docs/celix/documents/getting_started/using_services_with_cxx.md
rename to source/docs/2.2.0/celix/documents/getting_started/using_services_with_cxx.md
index 4669713..b652463 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_cxx.md
+++ b/source/docs/2.2.0/celix/documents/getting_started/using_services_with_cxx.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: using_services_with_cxx.md
+title: Using Services with C++
+version: 2.2.0
---
<!--
@@ -33,6 +34,7 @@ To start of, C++ service in Celix are just (abstract) classes.
In the following example there also a projected default constructor and destructor to ensure no instantiation / deletion of the service is possible:
```C++
+//IAnotherExample.h
#ifndef IANOTHER_EXAMPLE_H
#define IANOTHER_EXAMPLE_H
@@ -146,7 +148,7 @@ Component are concrete classes in C++. This do not have to implement specific in
## Code Examples
The next code blocks contains some code examples of components to indicate how to handle service dependencies, how to specify providing services and how to cope with locking/synchronizing.
-The complete example can be found [here](../../examples/services_example_cxx).
+The complete example can be found [here](../../examples/celix-examples/services_example_cxx).
### Bar Example
@@ -154,8 +156,8 @@ The Bar example is a simple component providing the C `example` service and C++
Note that the `Bar` component is just a plain old C++ object and does need to implement any specific Celix interfaces.
-The `BarActivator` is the entry point for a C++ bundle. It must implement the `DmActivator::create` method so that C++ Dependency manager can create a instance `DmActivator` without needing to known the subclass.
-It should also override the `DmActivator::init` to be able to declaratively program components and their provided service and service dependencies.
+The `BarActivator` is the entry point for a C++ bundle. It must implement the bundle activator functions so that the framework can start the bundles.
+It also used the C++ Dependency manager to declarative program components and their provided service and service dependencies.
The C++ Dependency Manager can use C++ member function pointers to control the component lifecycle (`init`, `start`, `stop` and `deinit`)
@@ -186,20 +188,19 @@ public:
```C++
//BarActivator.h
-#ifndef BAR_ACTIVATOR_H
+##ifndef BAR_ACTIVATOR_H
#define BAR_ACTIVATOR_H
-#include "celix/dm/DmActivator.h"
+#include "celix/dm/DependencyManager.h"
#include "example.h"
using namespace celix::dm;
-class BarActivator : public DmActivator {
+class BarActivator {
private:
example_t cExample {nullptr, nullptr};
public:
- BarActivator(DependencyManager& mng) : DmActivator(mng) {}
- virtual void init() override;
+ explicit BarActivator(std::shared_ptr<DependencyManager> mng);
};
#endif //BAR_ACTIVATOR_H
@@ -240,17 +241,16 @@ int Bar::cMethod(int arg1, double arg2, double *out) {
```C++
//BarActivator.cc
+#include <celix_api.h>
+
#include "Bar.h"
#include "BarActivator.h"
using namespace celix::dm;
-DmActivator* DmActivator::create(DependencyManager& mng) {
- return new BarActivator(mng);
-}
-void BarActivator::init() {
- std::shared_ptr<Bar> bar = std::shared_ptr<Bar>{new Bar{}};
+BarActivator::BarActivator(std::shared_ptr<DependencyManager> mng) {
+ auto bar = std::unique_ptr<Bar>{new Bar{}};
Properties props;
props["meta.info.key"] = "meta.info.value";
@@ -264,11 +264,13 @@ void BarActivator::init() {
return bar->cMethod(arg1, arg2, out);
};
- mng.createComponent(bar) //using a pointer a instance. Also supported is lazy initialization (default constructor needed) or a rvalue reference (move)
+ mng->createComponent(std::move(bar)) //using a pointer a instance. Also supported is lazy initialization (default constructor needed) or a rvalue reference (move)
.addInterface<IAnotherExample>(IANOTHER_EXAMPLE_VERSION, props)
.addCInterface(&this->cExample, EXAMPLE_NAME, EXAMPLE_VERSION, cProps)
.setCallbacks(&Bar::init, &Bar::start, &Bar::stop, &Bar::deinit);
}
+
+CELIX_GEN_CXX_BUNDLE_ACTIVATOR(BarActivator)
```
### Foo Example
@@ -293,6 +295,9 @@ public:
Foo() = default;
virtual ~Foo() = default;
+ Foo(const Foo&) = delete;
+ Foo& operator=(const Foo&) = delete;
+
void start();
void stop();
@@ -310,15 +315,13 @@ public:
#ifndef FOO_ACTIVATOR_H
#define FOO_ACTIVATOR_H
-#include "celix/dm/DmActivator.h"
+#include "celix/dm/DependencyManager.h"
using namespace celix::dm;
-class FooActivator : public DmActivator {
-private:
+class FooActivator {
public:
- FooActivator(DependencyManager& mng) : DmActivator(mng) {}
- virtual void init() override;
+ explicit FooActivator(std::shared_ptr<DependencyManager> mng);
};
#endif //FOO_ACTIVATOR_H
@@ -373,16 +376,13 @@ void Foo::poll() {
//FooActivator.cc
#include "Foo.h"
#include "FooActivator.h"
+#include <celix_api.h>
using namespace celix::dm;
-DmActivator* DmActivator::create(DependencyManager& mng) {
- return new FooActivator(mng);
-}
-
-void FooActivator::init() {
+FooActivator::FooActivator(std::shared_ptr<DependencyManager> mng) {
- Component<Foo>& cmp = mng.createComponent<Foo>()
+ Component<Foo>& cmp = mng->createComponent<Foo>()
.setCallbacks(nullptr, &Foo::start, &Foo::stop, nullptr);
cmp.createServiceDependency<IAnotherExample>()
@@ -395,6 +395,8 @@ void FooActivator::init() {
.setVersionRange(EXAMPLE_CONSUMER_RANGE)
.setCallbacks(&Foo::setExample);
}
+
+CELIX_GEN_CXX_BUNDLE_ACTIVATOR(FooActivator)
```
### Baz Example
@@ -447,15 +449,13 @@ public:
#ifndef BAZ_ACTIVATOR_H
#define BAZ_ACTIVATOR_H
-#include "celix/dm/DmActivator.h"
+#include "celix/dm/DependencyManager.h"
using namespace celix::dm;
-class BazActivator : public DmActivator {
-private:
+class BazActivator {
public:
- BazActivator(DependencyManager& mng) : DmActivator(mng) {}
- virtual void init() override;
+ explicit BazActivator(std::shared_ptr<DependencyManager> mng);
};
#endif //BAZ_ACTIVATOR_H
@@ -534,16 +534,13 @@ void Baz::poll() {
//BazActivator.cc
#include "Baz.h"
#include "BazActivator.h"
+#include <celix_api.h>
using namespace celix::dm;
-DmActivator* DmActivator::create(DependencyManager& mng) {
- return new BazActivator(mng);
-}
-
-void BazActivator::init() {
+BazActivator::BazActivator(std::shared_ptr<DependencyManager> mng) {
- Component<Baz>& cmp = mng.createComponent<Baz>()
+ Component<Baz>& cmp = mng->createComponent<Baz>()
.setCallbacks(nullptr, &Baz::start, &Baz::stop, nullptr);
cmp.createServiceDependency<IAnotherExample>()
@@ -558,6 +555,8 @@ void BazActivator::init() {
.setVersionRange(EXAMPLE_CONSUMER_RANGE)
.setCallbacks(&Baz::addExample, &Baz::removeExample);
}
+
+CELIX_GEN_CXX_BUNDLE_ACTIVATOR(BazActivator)
```
## Locking and Suspending
@@ -573,4 +572,4 @@ The suspend strategy has the advantage of reducing locks' usage: of course, susp
## See also
-See the [C++ Dependeny Manager](../../dependency_manager_cxx/readme.html) and [C++ Dependency Manager example](../../examples/dm_example_cxx) for more information and a more complex working example.
+See the [C++ Dependency Manager](../../libs/dependency_manager_cxx/README.html) and [C++ Dependency Manager example](../../examples/celix-examples/dm_example_cxx) for more information and a more complex working example.
diff --git a/source/docs/celix/documents/intro/readme.md b/source/docs/2.2.0/celix/documents/intro/README.md
similarity index 86%
rename from source/docs/celix/documents/intro/readme.md
rename to source/docs/2.2.0/celix/documents/intro/README.md
index 90a9e04..9bdc4cd 100644
--- a/source/docs/celix/documents/intro/readme.md
+++ b/source/docs/2.2.0/celix/documents/intro/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Introduction
+version: 2.2.0
---
<!--
@@ -139,23 +140,23 @@ Taking into account that C has no garbage collection handling the dynamic behavi
Apache Celix offers different solutions how to cope with this dynamic behaviour:
-* Bundle Context & Service References - This (low level) [API](../../framework/public/include/bundle_context.h) exists to be compatible with the OSGi standard. This should not be used in production code, because no locking/syncing mechanisms are available.
-* Service Listener - This (log level) [API](../../framework/public/include/service_listener.h) can be used to retrieve event when services are being removed or are added. Combined with locking this can be used to safely monitor and use services.
-* Service Tracker - This [API](../../framework/public/include/service_tracker.h) can be used to register callbacks function when services are being removed or are added. Combined with locking this can be used to safely use services.
-* [Dependency Manager](../../dependency_manager/readme.html) - This library can be used to add service dependency is a declarative way. A locking or syncing mechanism can be selected to safely use services. Note that this is not part of the OSGi standard.
+* Bundle Context & Service References - This (low level) [API](../../libs/framework/include/bundle_context.h) exists to be compatible with the OSGi standard. This should not be used in production code, because no locking/syncing mechanisms are available.
+* Service Listener - This (log level) [API](../../libs/framework/include/service_listener.h) can be used to retrieve event when services are being removed or are added. Combined with locking this can be used to safely monitor and use services.
+* Service Tracker - This [API](../../libs/framework/include/service_tracker.h) can be used to register callbacks function when services are being removed or are added. Combined with locking this can be used to safely use services.
+* [Dependency Manager](../../libs/dependency_manager/README.html) - This library can be used to add service dependency is a declarative way. A locking or syncing mechanism can be selected to safely use services. Note that this is not part of the OSGi standard.
Even though the dependency manager is not part of the OSGi specification, this is the preferred way because it uses a higher abstraction and removes a lot boilerplate code.
## C++ Support
One of the reasons why C was chosen as implementation language is that C can act as a common denominator for (service oriented) interoperability between a range of languages.
-C++ support is added with the use of a [C++ Dependency Manager](../../dependency_manager_cxx/readme.html).
+C++ support is added with the use of a [C++ Dependency Manager](../../libs/dependency_manager_cxx/README.html).
The Dependency Manager is arguably the most convenient way to interact with services, confers most uses cases and eliminates the necessity to port the rest of the (large) API to C++.
## Documentation
For more information see:
-* [Apache Celix - Building and Installing] (../building/readme.html)
-* [Apache Celix - Getting Started Guide](../getting_started/readme.html)
-* [Apache Celix - CMake Commands](../cmake_commands/readme.html)
+* [Apache Celix - Building and Installing](../building/README.html)
+* [Apache Celix - Getting Started Guide](../getting_started/README.html)
+* [Apache Celix - CMake Commands](../cmake_commands/README.html)
diff --git a/source/docs/2.2.0/celix/documents/subprojects/README.md b/source/docs/2.2.0/celix/documents/subprojects/README.md
new file mode 100644
index 0000000..33b1382
--- /dev/null
+++ b/source/docs/2.2.0/celix/documents/subprojects/README.md
@@ -0,0 +1,42 @@
+---
+type: celix-doc
+title: Subprojects
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Apache Celix - Subprojects
+
+Apache Celix is organized into several subprojects. The following subproject are currently available:
+
+* [Framework](../../libs/framework) - The Apache Celix framework, an implementation of OSGi adapted to C.
+* [C Dependency Manager](../../libs/dependency_manager/README.html) - A C component/dependency model for use through an API provided as library.
+* [C++ Dependency Manager](../../libs/dependency_manager_cxx/README.html) - A C++ component/dependency model for use through an API provided as library.
+* [Device Access](../../bundles/device_access/README.html) - An implementation of the OSGi Device Access specification adapted to C.
+* [Etcd library](../../libs/etcdlib/README.html) - A C library that interfaces with ETCD.
+* [Examples](../../examples) - A Selection of examples showing how the framework can be used.
+* [Log Service](../../bundles/log_service/README.html) - An implementation of the OSGi Log Service adapted to C.
+* [Log Writer](../../bundles/log_writer/README.html) - A simple log writer for use in combination with the Log Service.
+* [Remote Service Admin](../../bundles/remote_services/README.html) - An implementation of the OSGi Remote Service Admin Service - for several protocols - adapted to C.
+* [Shell](../../bundles/shell/shell/README.html) - A OSGi shell implementation.
+* [Shell TUI](../../bundles/shell/shell_tui/README.html) - A textual UI for the Celix Shell.
+* [Remote Shell](../../bundles/shell/remote_shell/README.html) - A remote (telnet) frontend for the Celix shell.
+* [Bonjour Shell](../../bundles/shell/shell_bonjour) - A remote (Bonjour / mDNS) frontend for the Celix shell.
+* [Deployment Admin](../../bundles/deployment_admin/README.html) - A deployment admin implementation.
+* [Pubsub](../../pubsub/README.html) - An implementation for a publish-subscribe remote services system, that use dfi library for message serialization.
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.2.0/celix/examples/celix-examples/README.md
similarity index 75%
copy from source/docs/celix/log_writer/README.md
copy to source/docs/2.2.0/celix/examples/celix-examples/README.md
index 01a69c8..c7dd193 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.2.0/celix/examples/celix-examples/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Celix Examples
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,10 +21,4 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Log Writer
-
-The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
-
-###### CMake options
- BUILD_LOG_WRITER=ON
- BUILD_LOG_WRITER_SYSLOG=ON
+# Celix Examples
diff --git a/source/docs/celix/shell_tui/README.md b/source/docs/2.2.0/celix/examples/celix-examples/http_example/README.md
similarity index 57%
rename from source/docs/celix/shell_tui/README.md
rename to source/docs/2.2.0/celix/examples/celix-examples/http_example/README.md
index 559004c..cec650f 100644
--- a/source/docs/celix/shell_tui/README.md
+++ b/source/docs/2.2.0/celix/examples/celix-examples/http_example/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: HTTP Example
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,15 +21,16 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-# Shell TUI
+# HTTP Example
+
+This examples shows how the Celix HTTP Admin can be used.
+
+This examples contains a `http_example` example bundle and uses the `Celix::http_admin` `Celix::shell` and `Celix::shell_wui`
+bundles to create a `http_example_cnt` Celix container.
-The Celix Shell TUI implements a textual user interface for the Celix Shell.
+The `http_example_cnt` Celix container shows how you can create a use existing http/websocket services.
+After running the container browse to localhost:8080.
+Under the /shell uri you find the `Celix::shell_wui` functionality and under /hello uri you find the `http_example` functionality
-## CMake option
- BUILD_SHELL_TUI=ON
-## Config options
-- SHELL_USE_ANSI_CONTROL_SEQUENCES - Wether to use ANSI control
-sequences to support backspace, left, up, etc key commands in the
-shell tui. Default is true if a TERM environment is set else false.
diff --git a/source/docs/2.2.0/celix/examples/celix-examples/services_example_c/README.md b/source/docs/2.2.0/celix/examples/celix-examples/services_example_c/README.md
new file mode 100644
index 0000000..e3f43ff
--- /dev/null
+++ b/source/docs/2.2.0/celix/examples/celix-examples/services_example_c/README.md
@@ -0,0 +1,89 @@
+---
+type: celix-doc
+title: Services example C
+version: 2.2.0
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Intro
+
+These examples shows howto create and interact with services by example.
+
+In both examples there is a provider and consumer bundle.
+The provider bundle creates services and registers them to the Celix framework so that these services are available for use (provide).
+And the consumer bundle request the services from the Celix framework and uses (consumes) them.
+
+The examples use the `celix_bundleContext_registerService` to provide
+services and uses a combination of `celix_bundleContext_useService`,
+`celix_bundleContext_useServices` and `celix_bundleContext_trackServices`
+to consume services.
+
+The bundle context is the proxy to the Celix framework for a bundle
+and can be used to:
+
+- Register services
+- Register service factories
+- Use services
+- Track services
+- Track bundles
+- Track service trackers
+
+See the `bundle_context.h` for documentation about these - and other -functions
+
+# Simple Service Provider & Consumer Example
+
+The simple provider/consumer example can be executed by launching the
+`services_example_c` executable target
+(build in `${CMAKE_BUILD_DIR}/deploy/services_example/services_example_c`)
+
+In this example the provider bundle only register one calc service. And
+the consumer bundle tries to use this during startup and registered
+a service tracker for the calc service.
+
+```ditaa
++----------------------+ +------------------------+
+| | | |
+| | | |
+| provider_example | example_calc | consumer_example |
+| +--------O)--------+ |
+| <bundle> | | <bundle> |
+| | | |
+| | | |
++----------------------+ +------------------------+
+```
+
+Try stopping/starting the provider/consumer bundles (respectively bundle id 3 & 4) using the interactive shell
+to see how this works at runtime.
+I.e. type `stop 3`, `stop 4`, `start 3`, `start 4` in different combinations.
+
+
+# Dynamic Service Provider & Consumer Example
+
+The dynamic provider/consumer example can be executed by launching the
+`dynamic_services_example_c` executable target
+(build in `${CMAKE_BUILD_DIR}/deploy/services_example/dynamic_services_example_c`)
+
+The dynamic service provide / consumer example show how the framework copes
+with the dynamic behaviour of services.
+
+This this example the provided dynamically register more and less calc services in a thread.
+The consumer bundle uses these services in a every 5 seconds and print some info.
+
+This example should give an idea how services can be safely used and tracked in a dynamic environment.
+
diff --git a/source/docs/celix/dependency_manager/readme.md b/source/docs/2.2.0/celix/libs/dependency_manager/README.md
similarity index 90%
rename from source/docs/celix/dependency_manager/readme.md
rename to source/docs/2.2.0/celix/libs/dependency_manager/README.md
index 71d2e0a..68758a4 100644
--- a/source/docs/celix/dependency_manager/readme.md
+++ b/source/docs/2.2.0/celix/libs/dependency_manager/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Dependency Manager
+version: 2.2.0
---
<!--
@@ -53,8 +54,7 @@ The Dependency Manager consist out of four main parts: `DM (Dependency Manager)
### DM Activator
-The `DM Activator` implements a "normal" Celix bundle activator and depends on four functions which needs to be implemented by the user of the Depedency Manager:
-
+The `DM Activator` implements a "normal" Celix bundle activator and depends on four functions which needs to be implemented by the user of the Dependency Manager:
- `dm_create` : Should be used to allocated and initialize a dm activator structure. If needed this structure can be used to store object during the lifecycle of the bundle.
- `dm_init` : Should be used to interact with the `Dependency Manager`. Here a user can components, service dependencies and provided services.
- `dm_destroy` : Should be used to deinitialize and deallocate objects created in the `dm_create` function.
@@ -62,7 +62,7 @@ The `DM Activator` implements a "normal" Celix bundle activator and depends on f
### Dependency Manager
-The `Dependency Manager` act as an entry point to add or remove DM Components. The `Dependency Manager` is provided to the `dm_init` functoin.
+The `Dependency Manager` act as an entry point to add or remove DM Components. The `Dependency Manager` is provided to the `dm_init` function.
### DM Component
@@ -137,17 +137,23 @@ celix_status_t dm_destroy(void * userData, bundle_context_pt context, dm_depende
}
```
+### References
+
+For more information examples please see
-### Dependency Manager Shell support
+- [The Dependency Manager API](../../libs/framework/include/celix/dm): The dependency manager header files
+- [Getting Started: Using Service with C](../../documents/getting_started/using_services_with_c.html): A introduction how to work with services using the dependency manager
+- [Dm example](../../examples/celix-examples/dm_example): A DM example.
+
+## Dependency Manager Shell support
There is support for retrieving information of the dm components with
use of the `dm` command. This command will print all known dm component,
their state, provided interfaces and required interfaces.
-### References
-For more information examples please see
+## Using info
-- [The Dependency Manager API](public/include): The dependency manager header files
-- [Getting Started: Using Service with C](../documents/getting_started/using_services_with_c.html): A introduction how to work with services using the dependency manager
-- [Dm example](../examples/dm_example): A DM example.
+If the Celix Dependency Manager is installed, 'find_package(Celix)' will set:
+ - The `Celix::dm_shell` bundle target
+ - The `Celix::dependency_manger_static` library target
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.2.0/celix/libs/dependency_manager/TODO.md
similarity index 75%
copy from source/docs/celix/log_writer/README.md
copy to source/docs/2.2.0/celix/libs/dependency_manager/TODO.md
index 01a69c8..9acfa91 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.2.0/celix/libs/dependency_manager/TODO.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: TODO.md
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,10 +21,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Log Writer
-
-The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
+# TODO integrate dep man into framework
-###### CMake options
- BUILD_LOG_WRITER=ON
- BUILD_LOG_WRITER_SYSLOG=ON
+- Update documentetion for CELIX_GEN_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
+- Move documentation
diff --git a/source/docs/celix/dependency_manager_cxx/readme.md b/source/docs/2.2.0/celix/libs/dependency_manager_cxx/README.md
similarity index 88%
rename from source/docs/celix/dependency_manager_cxx/readme.md
rename to source/docs/2.2.0/celix/libs/dependency_manager_cxx/README.md
index 9c09ff6..2452b08 100644
--- a/source/docs/celix/dependency_manager_cxx/readme.md
+++ b/source/docs/2.2.0/celix/libs/dependency_manager_cxx/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: C++ Dependency Manager
+version: 2.2.0
---
<!--
@@ -78,6 +79,12 @@ When correctly used this strategy removes the need for locking services during u
For more information examples please see
-- [The C++ Dependency Manager API](include/celix/dm): The c++ dependency manager header files
-- [Dm C++ example](../examples/dm_example_cxx): A DM C++ example.
-- [Getting Started: Using Services with C++](../documents/getting_started/using_services_with_cxx.html): A introduction how to work with services using the C++ dependency manager
+- [The C++ Dependency Manager API](../../libs/framework/include): The C++ dependency manager header files
+- [Dm C++ example](../../examples/celix-examples/dm_example_cxx): A DM C++ example.
+- [Getting Started: Using Services with C++](../../documents/getting_started/using_services_with_cxx.html): A introduction how to work with services using the C++ dependency manager
+
+## Using info
+
+If the Celix C++ Dependency Manager is installed, 'find_package(Celix)' will set:
+ - The `Celix::shell_api` interface (i.e. headers only) library target
+ - The `Celix::shell` bundle target
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.2.0/celix/libs/dependency_manager_cxx/TODO.md
similarity index 75%
copy from source/docs/celix/log_writer/README.md
copy to source/docs/2.2.0/celix/libs/dependency_manager_cxx/TODO.md
index 01a69c8..fc395c9 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.2.0/celix/libs/dependency_manager_cxx/TODO.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: TODO.md
+version: 2.2.0
---
<!--
@@ -10,7 +11,7 @@ this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -20,10 +21,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Log Writer
-
-The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
+# TODO integrate cxx dep man into framework
-###### CMake options
- BUILD_LOG_WRITER=ON
- BUILD_LOG_WRITER_SYSLOG=ON
+- Update documentetion for CELIX_GEN_CXX_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
+- Move documentation
diff --git a/source/docs/celix/etcdlib/README.md b/source/docs/2.2.0/celix/libs/etcdlib/README.md
similarity index 96%
rename from source/docs/celix/etcdlib/README.md
rename to source/docs/2.2.0/celix/libs/etcdlib/README.md
index 8fbe866..e293851 100644
--- a/source/docs/celix/etcdlib/README.md
+++ b/source/docs/2.2.0/celix/libs/etcdlib/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Etcdlib
+version: 2.2.0
---
<!--
@@ -21,11 +22,12 @@ limitations under the License.
-->
# Etcdlib
+
etcd is a distributed, consistent key-value store for shared configuration and service discovery, part of the CoreOS project.
This repository provides a library for etcd for C applications.
-Etcdlib can be used as part of Celix but is also useable stand-alone.
+Etcdlib can be used as part of Celix but is also usable stand-alone.
## Preparing
The following packages (libraries + headers) should be installed on your system:
diff --git a/source/docs/celix/launcher/README.md b/source/docs/2.2.0/celix/libs/launcher/README.md
similarity index 51%
rename from source/docs/celix/launcher/README.md
rename to source/docs/2.2.0/celix/libs/launcher/README.md
index b1812ef..e00a6a9 100644
--- a/source/docs/celix/launcher/README.md
+++ b/source/docs/2.2.0/celix/libs/launcher/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Launcher
+version: 2.2.0
---
<!--
@@ -28,10 +29,26 @@ The Launcher also passes the entire configuration to the Framework, this makes t
###### Properties
- cosgi.auto.start.1 Space delimited list of bundles to install and start when the
- Launcher/Framework is started. Note: Celix currently has no
- support for start levels, even though the "1" is meant for this.
- org.osgi.framework.storage sets the bundle cache directory
+ CELIX_AUTO_START_0 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 0, which is started first.
+
+ CELIX_AUTO_START_1 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 1.
+
+ CELIX_AUTO_START_2 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 2.
+
+ CELIX_AUTO_START_3 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 3.
+
+ CELIX_AUTO_START_4 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 4.
+
+ CELIX_AUTO_START_5 Space delimited list of bundles to install and start when the
+ Framework is started. The is for runtime level 5, which is started last.
+
+ org.osgi.framework.storage Sets the bundle cache directory
+
org.osgi.framework.storage.clean If set to "onFirstInit", the bundle cache will be flushed
when the framework starts
diff --git a/source/docs/celix/utils/README.md b/source/docs/2.2.0/celix/libs/utils/README.md
similarity index 94%
rename from source/docs/celix/utils/README.md
rename to source/docs/2.2.0/celix/libs/utils/README.md
index 3cec0fc..661dc8b 100644
--- a/source/docs/celix/utils/README.md
+++ b/source/docs/2.2.0/celix/libs/utils/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Utils
+version: 2.2.0
---
<!--
@@ -29,6 +30,3 @@ Celix Utils contains several useful containers/lists implementation used with th
Hash Map
Linked List
Thread Pool
-
-###### CMake option
- BUILD_UTILS=ON
diff --git a/source/docs/celix/utils/docs/thpool/Design.md b/source/docs/2.2.0/celix/libs/utils/docs/thpool/Design.md
similarity index 98%
rename from source/docs/celix/utils/docs/thpool/Design.md
rename to source/docs/2.2.0/celix/libs/utils/docs/thpool/Design.md
index 2908f86..7db4ca4 100644
--- a/source/docs/celix/utils/docs/thpool/Design.md
+++ b/source/docs/2.2.0/celix/libs/utils/docs/thpool/Design.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: Design.md
+title: C Thread Pool design
+version: 2.2.0
---
## High level
diff --git a/source/docs/celix/utils/docs/thpool/FAQ.md b/source/docs/2.2.0/celix/libs/utils/docs/thpool/FAQ.md
similarity index 87%
rename from source/docs/celix/utils/docs/thpool/FAQ.md
rename to source/docs/2.2.0/celix/libs/utils/docs/thpool/FAQ.md
index 7ef617d..c235af0 100644
--- a/source/docs/celix/utils/docs/thpool/FAQ.md
+++ b/source/docs/2.2.0/celix/libs/utils/docs/thpool/FAQ.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: FAQ.md
+title: C Thread Pool FAQ
+version: 2.2.0
---
@@ -16,13 +17,13 @@ Interestingly using `pthread_exit()` results in much more memory being allocated
### Why do you use sleep() after calling thpool_destroy()?
This is needed only in the tests. The reason is that if you call thpool_destroy
-and then exit immedietely, maybe the program will exit before all the threads
+and then exit immediately, maybe the program will exit before all the threads
had the time to deallocate. In that way it is impossible to check for memory
leaks.
In production you don't have to worry about this since if you call exit,
-immedietely after you destroyied the pool, the threads will be freed
-anyway by the OS. If you eitherway destroy the pool in the middle of your
+immediately after you destroyed the pool, the threads will be freed
+anyway by the OS. If you either way destroy the pool in the middle of your
program it doesn't matter again since the program will not exit immediately
and thus threads will have more than enough time to terminate.
diff --git a/source/docs/celix/utils/docs/thpool/README.md b/source/docs/2.2.0/celix/libs/utils/docs/thpool/README.md
similarity index 98%
rename from source/docs/celix/utils/docs/thpool/README.md
rename to source/docs/2.2.0/celix/libs/utils/docs/thpool/README.md
index 31d86b1..c200e16 100644
--- a/source/docs/celix/utils/docs/thpool/README.md
+++ b/source/docs/2.2.0/celix/libs/utils/docs/thpool/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: C Thread Pool
+version: 2.2.0
---

diff --git a/source/docs/celix/utils/public/include/memstream/README.md b/source/docs/2.2.0/celix/libs/utils/include/memstream/README.md
similarity index 98%
rename from source/docs/celix/utils/public/include/memstream/README.md
rename to source/docs/2.2.0/celix/libs/utils/include/memstream/README.md
index 4058c0b..e84fe63 100644
--- a/source/docs/celix/utils/public/include/memstream/README.md
+++ b/source/docs/2.2.0/celix/libs/utils/include/memstream/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: memstream
+version: 2.2.0
---
fmemopen for Mac OS and iOS
diff --git a/source/docs/celix/log_writer/README.md b/source/docs/2.2.0/celix/misc/experimental/README.md
similarity index 76%
rename from source/docs/celix/log_writer/README.md
rename to source/docs/2.2.0/celix/misc/experimental/README.md
index 01a69c8..e8345f3 100644
--- a/source/docs/celix/log_writer/README.md
+++ b/source/docs/2.2.0/celix/misc/experimental/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: README.md
+title: Intro
+version: 2.2.0
---
<!--
@@ -20,10 +21,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-## Log Writer
+# Intro
-The Celix Log Writers are components that read/listen to the Log Service and print the Log entries to the console or syslog, respectively.
-
-###### CMake options
- BUILD_LOG_WRITER=ON
- BUILD_LOG_WRITER_SYSLOG=ON
+This directory contains experimental bundles and libraries.
+These bundles/libraries are not considered stable and/or their API can still drastically change.
diff --git a/source/docs/celix/config_admin/readme.md b/source/docs/2.2.0/celix/misc/experimental/bundles/config_admin/README.md
similarity index 92%
rename from source/docs/celix/config_admin/readme.md
rename to source/docs/2.2.0/celix/misc/experimental/bundles/config_admin/README.md
index bcdbc13..0ee5eaf 100644
--- a/source/docs/celix/config_admin/readme.md
+++ b/source/docs/2.2.0/celix/misc/experimental/bundles/config_admin/README.md
@@ -1,6 +1,7 @@
---
type: celix-doc
-title: readme.md
+title: Configuration Admin
+version: 2.2.0
---
<!--
@@ -26,7 +27,7 @@ limitations under the License.
## Introduction
The configuration Admin service allows defining and deploying configuration data to bundles.
-When compared to config.properties it adds the option to update configuration data by providing a persisten storage. It also allows changing configuration data at run-time.
+When compared to config.properties it adds the option to update configuration data by providing a persistent storage. It also allows changing configuration data at run-time.
---
@@ -56,4 +57,4 @@ service.pid
This bundle has to register next to its normal service a managed service that has an update method. This managed service needs to be registered with a properties object that contains the key/value pair service.pid=<PID NAME>.
Use config_admin_tst/example_test as an example (it is better than example_test2)
2. Bundle/application that wants to update the configuration data of the system
- This bundle needs to retrieve the running config_admin service. With this service it can retrieve all configuration objects for all known Persistent Identifiers (PIDs). For each PID, get all properites that need to be updated. See config_admin_test for an example.
+ This bundle needs to retrieve the running config_admin service. With this service it can retrieve all configuration objects for all known Persistent Identifiers (PIDs). For each PID, get all properties that need to be updated. See config_admin_test for an example.
diff --git a/source/docs/2.2.0/docs.md b/source/docs/2.2.0/docs.md
new file mode 100644
index 0000000..afd5be2
--- /dev/null
+++ b/source/docs/2.2.0/docs.md
@@ -0,0 +1,21 @@
+---
+title: Documentation for v2.2.0
+version: 2.2.0
+---
+
+# Documentation for Celix v2.2.0
+
+Get started with Celix by going through the appropriate content.
+
+Please follow the links below to find appropriate content:
+
+ - [Introduction](./celix/documents/intro/README.html)
+ - [Getting Started](./celix/documents/getting_started/README.html)
+ - [CMake Commands](./celix/documents/cmake_commands/README.html)
+ - [Building](./celix/documents/building/README.html)
+ - [Subprojects](./celix/documents/subprojects/README.html)
+
+View the 2.2.0 changelog [here](./celix/CHANGES.html).
+
+> The [Celix mailing list](/support/mailing-list.html) is an excellent place to reach out for help. If you don't find
+> an answer to your problem in the mailing list archives, post a new question on the mailing list.
diff --git a/source/docs/docs.md b/source/docs/docs.md
deleted file mode 100644
index e1b1d83..0000000
--- a/source/docs/docs.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-title: Documentation
----
-
-# Documentation
-
-Get started with Celix by going through the appropriate content.
-
-Please follow the links below to find appropriate content:
-
- - [Introduction](/docs/celix/documents/intro/readme.html)
- - [Getting Started](/docs/celix/documents/getting_started/readme.html)
- - [CMake Commands](/docs/celix/documents/cmake_commands/readme.html)
- - [Building](/docs/celix/documents/building/readme.html)
- - [Subprojects](/docs/celix/documents/subprojects/readme.html)
-
-View our roadmap to view future plans for Celix
-
- - [Roadmap](/docs/celix/documents/roadmap/roadmap.html)
-
-> The [Celix mailing list](/support/mailing-list.html) is an excellent place to reach out for help. If you don't find
-> an answer to your problem in the mailing list archives, post a new question on the mailing list.
diff --git a/source/support/issue-tracking.md b/source/support/issue-tracking.md
index 6f8e65f..0be906b 100644
--- a/source/support/issue-tracking.md
+++ b/source/support/issue-tracking.md
@@ -4,16 +4,18 @@ title: Issue Tracking
# Issue Tracking
-Celix uses Jira for bug reports, feature requests, enhancements and tasks of all kind.
+Celix uses GitHub issues for bug reports, feature requests, enhancements and tasks of all kind.
-Anyone can use Jira to report bugs. But before doing so, please make sure that:
+Anyone with a GitHub account can use GitHub to create issues. But before doing so, please make sure that:
-* the bug isn't already reported,
+* the issue has not already been reported,
* the problem is actually a bug (the [mailing list](mailing-list.html) can be used for support),
-* you attach enough information to replicate the bug (preferably a unit test)
+* if it's a bug, you attach enough information to replicate the bug (preferably a unit test)
-If you have fixed a bug, the patch can be attached to a bug report.
+If you have fixed a bug or added a new feature, a [pull request](https://github.com/apache/celix/pulls) to the Celix
+repository can be created.
-The Celix Jira Issue Tracker can be found at:
+Celix its issues are tracked on the following pages:
-[https://issues.apache.org/jira/browse/CELIX](https://issues.apache.org/jira/browse/CELIX)
+- Celix main repository: https://github.com/apache/celix/issues
+- Celix website repository: https://github.com/apache/celix-site/issues
diff --git a/source/support/mailing-list.md b/source/support/mailing-list.md
index 6796be1..8dddc22 100644
--- a/source/support/mailing-list.md
+++ b/source/support/mailing-list.md
@@ -24,6 +24,5 @@ including passwords, server names, ips and so on.</p>
## Archives
-You can read the [ASF Mail](http://mail-archives.apache.org/mod_mbox/celix-dev/) or the
-[Pony Mail](https://lists.apache.org/list.html?dev@celix.apache.org) archives if you are looking for older discussions.
-There are many other archives out there as well.
+You can read the [Pony Mail](https://lists.apache.org/list.html?dev@celix.apache.org) archives if you are looking for
+older discussions. There are many other archives out there as well.