CELIX-368: Updates some wrong links in the documentation
Project: http://git-wip-us.apache.org/repos/asf/celix/repo Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/454745c8 Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/454745c8 Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/454745c8 Branch: refs/heads/master Commit: 454745c890909d3f407c6a344ce232b57ddb4e0a Parents: 97cc924 Author: Pepijn Noltes <pepijnnol...@gmail.com> Authored: Thu Aug 4 22:06:33 2016 +0200 Committer: Pepijn Noltes <pepijnnol...@gmail.com> Committed: Thu Aug 4 22:06:33 2016 +0200 ---------------------------------------------------------------------- README.md | 2 +- documents/cmake_commands/readme.md | 13 ++++++++++--- documents/intro/readme.md | 18 +++++++++--------- 3 files changed, 20 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/celix/blob/454745c8/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index a2bfe43..4f7b9d0 100644 --- a/README.md +++ b/README.md @@ -8,5 +8,5 @@ For information how to build Apache Celix see [Building Apache Celix](documents/ For an introduction into Apache Celix see [Apache Celix Intro](documents/intro/readme.md) ##Getting Started with Apache Celix -For a guide how to start writing your own bundles and services see [Getting Started Guide](documents/intro/readme.md) +For a guide how to start writing your own bundles and services see [Getting Started Guide](documents/getting_started/readme.md) http://git-wip-us.apache.org/repos/asf/celix/blob/454745c8/documents/cmake_commands/readme.md ---------------------------------------------------------------------- diff --git a/documents/cmake_commands/readme.md b/documents/cmake_commands/readme.md index c386f41..a796180 100644 --- a/documents/cmake_commands/readme.md +++ b/documents/cmake_commands/readme.md @@ -186,7 +186,10 @@ Deploy a selection of bundles to the provided bundle dir. This can be used to cr ```CMake deploy_bundles_dir(<deploy_target_name> DIR_NAME dir_name - BUNDLES bundle1 bundle2 ... + BUNDLES + bundle1 + bundle2 + ... ) ``` @@ -195,7 +198,9 @@ Deploy the selected bundles. The bundles are configured for auto starting. ```CMake deploy_bundles(<deploy_target_name> - bundle1 bundle2 ... + bundle1 + bundle2 + ... ) ``` @@ -205,6 +210,8 @@ deploy_bundles(<deploy_target_name> Add the provided properties to the target deploy config.properties. deploy_properties(<deploy_target_name> - "prop1=val1" "prop2=val2" ... + "prop1=val1" + "prop2=val2" + ... ) http://git-wip-us.apache.org/repos/asf/celix/blob/454745c8/documents/intro/readme.md ---------------------------------------------------------------------- diff --git a/documents/intro/readme.md b/documents/intro/readme.md index 6b10fb3..4d2ea99 100644 --- a/documents/intro/readme.md +++ b/documents/intro/readme.md @@ -91,8 +91,8 @@ void hashMapIterator_deinit(hash_map_iterator_pt iterator); Apache Celix follows the OSGi API as close as possible, but since the OSGi specification is written primarily for Java, there will be differences (Java is OO, C is procedural). Taking into account those differences and mapping explained before the OSGi javadoc can be used for a more in depth description of what the Apache Celix API offers. -[OSGi core specification 4.3](https://osgi.org/javadoc/r4v43/core/index.html) -[OSGi compendium specification 4.3](https://osgi.org/javadoc/r4v43/cmpn/index.html) +* [OSGi core specification 4.3](https://osgi.org/javadoc/r4v43/core/index.html) +* [OSGi compendium specification 4.3](https://osgi.org/javadoc/r4v43/cmpn/index.html) ##What is a OSGi service? A OSGi service is a Java object register to the OSGi framework under a certain set of properties. @@ -103,7 +103,7 @@ Consumers can dynamically lookup the services providing a filter to specify what ##C services in Apache Celix As mentioned OSGi uses Java Interfaces to define a service. Since C does not have Interfaces as compilable unit, this is not possible for Celix. To be able to define a service which hides implementation details, Celix uses structs with function pointers. -See [Apache Celix Best Practices](../best_practices/README.md) for a more in depth look at services and service usage. +See [Apache Celix Best Practices](../best_practices/readme.md) for a more in depth look at services and service usage. ##Impact of dynamic services Services in Apache Celix are dynamic, meaning that they can come and go at any moment. @@ -114,17 +114,17 @@ 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 - This [library](../dependency_manager/readme.md) 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](../../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.md) - 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.md). +C++ support is added with the use of a [C++ Dependency Manager](../../dependency_manager_cxx/readme.md). 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 @@ -134,4 +134,4 @@ For more information see: * [Apache Celix - Building and Installing] (../building/readme.md) * [Apache Celix - Getting Started Guide](../getting_started/readme.md) * [Apache Celix - Best Practices](../best_practices/readme.md) -* [Apache Celix - CMake Commands](../cmake_commands/readme.md) \ No newline at end of file +* [Apache Celix - CMake Commands](../cmake_commands/readme.md)
