CELIX-335: Update of cmake command docs and added subproject doc.
Project: http://git-wip-us.apache.org/repos/asf/celix/repo Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/66ff6263 Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/66ff6263 Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/66ff6263 Branch: refs/heads/develop Commit: 66ff62636da7f3fbb86cfed9f052e3dd00ba7b23 Parents: 5b4e5ff Author: Pepijn Noltes <pepijnnol...@gmail.com> Authored: Mon Jan 25 13:44:26 2016 +0100 Committer: Pepijn Noltes <pepijnnol...@gmail.com> Committed: Mon Jan 25 13:44:26 2016 +0100 ---------------------------------------------------------------------- documents/cmake_commands/readme.md | 42 ++++++++++++++++----------------- documents/subprojects/readme.md | 23 ++++++++++++++++++ 2 files changed, 44 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/celix/blob/66ff6263/documents/cmake_commands/readme.md ---------------------------------------------------------------------- diff --git a/documents/cmake_commands/readme.md b/documents/cmake_commands/readme.md index d95d07e..e9f994e 100644 --- a/documents/cmake_commands/readme.md +++ b/documents/cmake_commands/readme.md @@ -1,6 +1,6 @@ #Apache Celix - CMake Commands -For Apache Celix several cmake command are added to be able to work with bundles and Apache Celix deployments. +For Apache Celix several cmake command are added to be able to work with Apache Celix bundles and deployments. #Bundles @@ -51,15 +51,15 @@ add_bundle(<bundle_target_name> ) ``` -If NAME is provided that will be used as Bundle-Name. Default the bundle target name is used as symbolic name. -If SYMBOLIC_NAME is provided that will be used as Bundle-SymbolicName. Default the bundle target name is used as symbolic name. -If DESCRIPTION is provided that will be used as Bundle-Description. Default this is empty -if VERSION is provided. That will be used for the Bundle-Version. In combination with SOURCES the version will alse be use to set the activator library target property VERSION and SOVERSION. +- If NAME is provided that will be used as Bundle-Name. Default the bundle target name is used as symbolic name. +- If SYMBOLIC_NAME is provided that will be used as Bundle-SymbolicName. Default the bundle target name is used as symbolic name. +- If DESCRIPTION is provided that will be used as Bundle-Description. Default this is empty +- If VERSION is provided. That will be used for the Bundle-Version. In combination with SOURCES the version will alse be use 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" If PRIVATE_LIBRARIES is provided all provided lib 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. -If EXPORT_LIBRARIES is provided all provided lib are added to the "Export-Library" manifest statement and added in the root of the bundle. libraries can be cmake library targets or absolute paths to existing libraries. This is not yet supported by the celix framework. -If EXPORT_LIBRARIES is provided all provided lib are added to the "Import-Library" manifest statement and added in the root of the bundle. libraries can be cmake library targets or absolute paths to existing libraries. This is not yet supported by the celix framework -If HEADERS is provided the headers values are appended to the bundle manifest. +- If EXPORT_LIBRARIES is provided all provided lib are added to the "Export-Library" manifest statement and added in the root of the bundle. libraries can be cmake library targets or absolute paths to existing libraries. This is not yet supported by the celix framework. +- If EXPORT_LIBRARIES is provided all provided lib are added to the "Import-Library" manifest statement and added in the root of the bundle. libraries can be cmake library targets or absolute paths to existing libraries. This is not yet supported by the celix framework +- If HEADERS is provided the headers values are appended to the bundle manifest. ##bundle_private_libs Add libraries to a bundle target. The libraries should be cmake library targets or an absolute path to a existing library. @@ -129,9 +129,9 @@ bundle_description(<bundle_target> description) ##install_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/<pronect_name>/<bundle_name> +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>` ```CMake install_bundle(<bundle_target> @@ -142,17 +142,17 @@ install_bundle(<bundle_target> ) ``` -If PROJECT_NAME is provided that will be used as project name for installing. Default is the cmake project name. -If BUNDLE_NAME is provided that will be used as bundle for installing the headers. Default is the bundle target name. -if HEADERS is provided the list of provided headers will be installed. -if RESOURCES is provided the list of provided resources will be installed. +- If PROJECT_NAME is provided that will be used as project name for installing. Default is the cmake project name. +- If BUNDLE_NAME is provided that will be used as bundle for installing the headers. Default is the bundle target name. +- If HEADERS is provided the list of provided headers will be installed. +- If RESOURCES is provided the list of provided resources will be installed. #Deployments #add_deploy Add a deployment, consisting out of a selection of bundles, for the project. Deployments can be used to run/test a selection of bundles in the celix framework. -A deployment can be found in <cmake_build_dir>/deploy[/<group_name>]/<deploy_name>. +A deployment can be found in `<cmake_build_dir>/deploy[/<group_name>]/<deploy_name>`. Use the run.sh to run the deployments. ```CMake @@ -165,11 +165,11 @@ add_deploy(<deploy_target_name> ) ``` -If COPY is provided the selected bundles will be copied in a bundles dir and the generated config.properties will use relative paths to the bundle locations. Default bundles will not be copied and the generated config.properties will use absolute references to the bundle locations. -If GROUP is provided the deployment will be grouped in the provided group name. -If NAME is provided that name will be used for the deployment dir. Default the deploy target name will be used. -If BUNDLES is provided the list of bundles will be added the the generated config.properties for startup. Combined with COPY the bundles will also be copied to a bundles dir. -If PROPERTIES is provided the list of properties will be appended to the generated config.properties +- If COPY is provided the selected bundles will be copied in a bundles dir and the generated config.properties will use relative paths to the bundle locations. Default bundles will not be copied and the generated config.properties will use absolute references to the bundle locations. +- If GROUP is provided the deployment will be grouped in the provided group name. +- If NAME is provided that name will be used for the deployment dir. Default the deploy target name will be used. +- If BUNDLES is provided the list of bundles will be added the the generated config.properties for startup. Combined with COPY the bundles will also be copied to a bundles dir. +- If PROPERTIES is provided the list of properties will be appended to the generated config.properties #deploy_bundles_dir Deploy a selection of bundles to the provided bundle dir. This can be used to create an endpoints / proxies bundles dir for the remote service admin or drivers bundles dir for the device access. http://git-wip-us.apache.org/repos/asf/celix/blob/66ff6263/documents/subprojects/readme.md ---------------------------------------------------------------------- diff --git a/documents/subprojects/readme.md b/documents/subprojects/readme.md new file mode 100644 index 0000000..e5aad85 --- /dev/null +++ b/documents/subprojects/readme.md @@ -0,0 +1,23 @@ +#Apache Celix - Subprojects + +Apache Celix is organized into several subprojects. The following subproject are currently available: + +* [Framework](../framework) - The Apache Celix framework, an implementation of OSGi adapted to C. +* [Dependency Manager](../dependency_manager) - A component/dependency model for use through an API provided as library. +* [Device Access](../device_access) - An implementation of the OSGi Device Access specification adapted to C. +* [Examples](../examples) - A Selection of examples showing how the framework can be used. +* [Log Service](../log_service) - An implementation of the OSGi Log Service adapated to C. +* [Log Writer](../log_writer) - A simple log writer for use in combination with the Log Service. +* [Remote Service Admin](../remote_services) - An implementation of the OSGi Remote Service Admin Service - for several protocols - adapted to C. + * [Remote Service Admin HTTP](../remote_services/remote_service_admin_http) - A HTTP implementation of the RSA. + * [Remote Service Admin DFI](../remote_services/remote_service_admin_dfi) - A Dynamic Function Interface (DFI) implementation of the RSA. + * [Remote Service Admin SHM](../remote_services/remote_service_admin_shm) - A shared memory implementation of the RSA. + * [Topology Manager](../remote_services/topology_manager) - A (scoped) RSA Topology Manager implementation. + * [Discovery Configured](../remote_services/discovery_configured) - A RSA Discovery implementation using static configuration (xml). + * [Discovery Etcd](../remote_services/dicovery_etcd) - A RSA Discovery implementation using etcd. + * [Discovery SHM](../remote_services/dicovery_shm) - A RSA Discovery implementation using shared memory. +* [Shell](../shell) - A OSGi shell implementation. +* [Shell TUI](../shell_tui) - A textual UI for the Celix Shell. +* [Remote Shell](../remote_shell) - A remote (telnet) frontend for the Celix Shell. +* [Deployment Admin](../deployment_admin) - A deployment admin implementation. +
