Return-Path: X-Original-To: apmail-celix-commits-archive@www.apache.org Delivered-To: apmail-celix-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 5862D18903 for ; Thu, 17 Dec 2015 20:11:48 +0000 (UTC) Received: (qmail 72228 invoked by uid 500); 17 Dec 2015 20:11:48 -0000 Delivered-To: apmail-celix-commits-archive@celix.apache.org Received: (qmail 72205 invoked by uid 500); 17 Dec 2015 20:11:48 -0000 Mailing-List: contact commits-help@celix.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@celix.apache.org Delivered-To: mailing list commits@celix.apache.org Received: (qmail 72196 invoked by uid 99); 17 Dec 2015 20:11:48 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 Dec 2015 20:11:48 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 1F9BAE112C; Thu, 17 Dec 2015 20:11:48 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: bpetri@apache.org To: commits@celix.apache.org Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: celix git commit: CELIX-330: add some documentation describing cmake option and properties Date: Thu, 17 Dec 2015 20:11:48 +0000 (UTC) Repository: celix Updated Branches: refs/heads/develop d5a51766c -> cf00b5a9b CELIX-330: add some documentation describing cmake option and properties Project: http://git-wip-us.apache.org/repos/asf/celix/repo Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/cf00b5a9 Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/cf00b5a9 Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/cf00b5a9 Branch: refs/heads/develop Commit: cf00b5a9b5d1910df42634ee73163f160e274667 Parents: d5a5176 Author: Bjoern Petri Authored: Thu Dec 17 21:10:05 2015 +0100 Committer: Bjoern Petri Committed: Thu Dec 17 21:10:05 2015 +0100 ---------------------------------------------------------------------- deployment_admin/README.md | 14 ++++++++++++++ device_access/README.md | 10 ++++++++++ launcher/README.md | 17 +++++++++++++++++ log_service/README.md | 12 ++++++++++++ log_writer/README.md | 7 +++++++ remote_services/README.md | 8 ++++++++ remote_shell/README.md | 10 ++++++++++ shell/README.md | 23 +++++++++++++++++++++++ shell_tui/README.md | 6 ++++++ utils/README.md | 12 ++++++++++++ 10 files changed, 119 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/deployment_admin/README.md ---------------------------------------------------------------------- diff --git a/deployment_admin/README.md b/deployment_admin/README.md new file mode 100644 index 0000000..d28559c --- /dev/null +++ b/deployment_admin/README.md @@ -0,0 +1,14 @@ +## Deployment Admin + +The Celix Deployment Admin implements the OSGi Deployment Admin specification, which provides functionality to manage deployment packages. Deployment package are bundles and other artifacts that can be installed, updated and uninstalled as single unit. + +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 + +###### CMake option + BUILD_DEPLOYMENT_ADMIN=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/device_access/README.md ---------------------------------------------------------------------- diff --git a/device_access/README.md b/device_access/README.md new file mode 100644 index 0000000..d58601d --- /dev/null +++ b/device_access/README.md @@ -0,0 +1,10 @@ +## Device Access + +The Device Access contains a for Celix adapted implementation of the OSGi Compendium Device Access Specification. + +###### 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 + BUILD_DEVICE_ACCESS=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/launcher/README.md ---------------------------------------------------------------------- diff --git a/launcher/README.md b/launcher/README.md new file mode 100644 index 0000000..a1e29fb --- /dev/null +++ b/launcher/README.md @@ -0,0 +1,17 @@ +## Launcher + +The Celix Launcher is a generic executable for launching the Framework. It reads a java properties based configuration file. + +The Launcher also passes the entire configuration to the Framework, this makes them available to the bundleContext_getProperty function. + +###### 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 + org.osgi.framework.storage.clean If set to "onFirstInit", the bundle cache will be flushed + when the framework starts + +###### CMake option + BUILD_LAUNCHER=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/log_service/README.md ---------------------------------------------------------------------- diff --git a/log_service/README.md b/log_service/README.md new file mode 100644 index 0000000..32ee520 --- /dev/null +++ b/log_service/README.md @@ -0,0 +1,12 @@ +## 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](public/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 http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/log_writer/README.md ---------------------------------------------------------------------- diff --git a/log_writer/README.md b/log_writer/README.md new file mode 100644 index 0000000..6de181d --- /dev/null +++ b/log_writer/README.md @@ -0,0 +1,7 @@ +## 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 http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/remote_services/README.md ---------------------------------------------------------------------- diff --git a/remote_services/README.md b/remote_services/README.md new file mode 100644 index 0000000..669f3c4 --- /dev/null +++ b/remote_services/README.md @@ -0,0 +1,8 @@ +## Remote Services + +Celix Remote Services contains several implementations of the OSGi Remote Services and Enterprise Remote Service Admin Service Specification: + +* **Remote Service Admin** implements functionality to import/export services through a set of configuration types. The Remote Service Admin service is a passive Distribution Provider, not taking any action to export or import itself. +* **Topology Manager** provides the policy for importing and exporting services +through the Remote Service Admin service. +* **Discovery** provides detection of exported services through some discovery protocol. http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/remote_shell/README.md ---------------------------------------------------------------------- diff --git a/remote_shell/README.md b/remote_shell/README.md new file mode 100644 index 0000000..09edcd8 --- /dev/null +++ b/remote_shell/README.md @@ -0,0 +1,10 @@ +## Remote Shell + +The Celix Remote Shell implements a telnet interface for the Celix Shell. + +###### Properties + remote.shell.telnet.port used port (default: 6666) + remote.shell.telnet.maxconn amount of concurrent connections (default: 2) + +###### CMake option + BUILD_REMOTE_SHELL=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/shell/README.md ---------------------------------------------------------------------- diff --git a/shell/README.md b/shell/README.md new file mode 100644 index 0000000..71511c3 --- /dev/null +++ b/shell/README.md @@ -0,0 +1,23 @@ +## Shell + +The Celix Shell provides a service interface which can be used to interact with the Celix framework. Note that it does not offer a user interface. This modular approach enables having multiple frontends, e.g. textual or graphical. + +While the shell can be extended with additional commands by other bundles, it already offers some built in commands: + + lb list bundles + install install additional bundle + uninstall uninstall bundles + update update bundles + + start start bundle + stop stop bundle + + help displays available commands + inspect inspect service and components + + log print log + +Further information about a command can be retrieved by using `help` combined with the command. + +###### CMake options + BUILD_SHELL=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/shell_tui/README.md ---------------------------------------------------------------------- diff --git a/shell_tui/README.md b/shell_tui/README.md new file mode 100644 index 0000000..4cdcda4 --- /dev/null +++ b/shell_tui/README.md @@ -0,0 +1,6 @@ +## Shell TUI + +The Celix Shell TUI implements a textual user interface for the Celix Shell. + +###### CMake option + BUILD_SHELL_TUI=ON http://git-wip-us.apache.org/repos/asf/celix/blob/cf00b5a9/utils/README.md ---------------------------------------------------------------------- diff --git a/utils/README.md b/utils/README.md new file mode 100644 index 0000000..9f02e8a --- /dev/null +++ b/utils/README.md @@ -0,0 +1,12 @@ +## Utils + +Celix Utils contains several useful containers/lists implementation used with the Celix project. The following types are available: + + Array List + Celix Thread Container + Hash Map + Linked List + Thread Pool + +###### CMake option + BUILD_UTILS=ON