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 2022/07/17 17:29:56 UTC

[celix] branch fix-links created (now 4d89f2f9)

This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a change to branch fix-links
in repository https://gitbox.apache.org/repos/asf/celix.git


      at 4d89f2f9 Update the caption for the sequence diagrams to not be a header

This branch includes the following new commits:

     new 4c12efba Add README.md to links and fix the OSGI links
     new 4d89f2f9 Update the caption for the sequence diagrams to not be a header

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[celix] 02/02: Update the caption for the sequence diagrams to not be a header

Posted by rl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a commit to branch fix-links
in repository https://gitbox.apache.org/repos/asf/celix.git

commit 4d89f2f93c680f14f7c98d428fe0e80b1e3cbb94
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Sun Jul 17 19:29:44 2022 +0200

    Update the caption for the sequence diagrams to not be a header
    
    Having this as italic element also allows for better readability on the website
---
 documents/services.md | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/documents/services.md b/documents/services.md
index 81e22a25..64336d21 100644
--- a/documents/services.md
+++ b/documents/services.md
@@ -329,21 +329,24 @@ CELIX_GEN_CXX_BUNDLE_ACTIVATOR(MyCShellCommandProviderBundleActivator)
 ```
 
 ### Sequence diagrams for service registration
+
 ![Register Service Async](diagrams/services_register_service_async_seq.png)
-A asynchronized service registration
+*An asynchronized service registration*
+
 ---
 
 ![Register Service Async](diagrams/services_register_service_seq.png)
-A synchronized service registration
+*A synchronized service registration*
+
 ---
 
 ![Unregister Service Async](diagrams/services_unregister_service_async_seq.png)
-A asynchronized service un-registration
+*An asynchronized service un-registration*
+
 ---
 
 ![Unregister Service Async](diagrams/services_unregister_service_seq.png)
-A synchronized service un-registration
----
+*A synchronized service un-registration*
 
 ## Using services
 Services can be used directly using the bundle context C functions or C++ methods:
@@ -611,20 +614,22 @@ CELIX_GEN_CXX_BUNDLE_ACTIVATOR(TrackingCommandServicesExample)
 ### Sequence diagrams for service tracker and service registration
 
 ![Register Service Async](diagrams/services_tracker_services_add_async_seq.png)
-Service tracker callback with an asynchronized service registration
+*Service tracker callback with an asynchronized service registration*
+
 ---
 
 ![Register Service Async](diagrams/services_tracker_services_rem_async_seq.png)
-Service tracker callback with an asynchronized service un-registration
+*Service tracker callback with an asynchronized service un-registration*
+
 ---
 
 ![Register Service Async](diagrams/services_tracker_services_add_seq.png)
-Service tracker callback with a synchronized service registration
+*Service tracker callback with a synchronized service registration*
+
 ---
 
 ![Register Service Async](diagrams/services_tracker_services_rem_seq.png)
-Service tracker callback with a synchronized service un-registration
----
+*Service tracker callback with a synchronized service un-registration*
 
 # The `celix::query` shell command
 To interactively see the which service and service trackers are available the `celix::query` shell command

[celix] 01/02: Add README.md to links and fix the OSGI links

Posted by rl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a commit to branch fix-links
in repository https://gitbox.apache.org/repos/asf/celix.git

commit 4c12efbaba05e2871a24cb2683bf27ef8b5fd90c
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Sun Jul 17 19:28:40 2022 +0200

    Add README.md to links and fix the OSGI links
    
    The README.md is needed since Hugo (the static website generator Celix uses) otherwise will create a link to a directory, where it searches for an index.html file instead of a README.html. Having the README.md in the link will ensure that both GitHub and Hugo handle the link correctly.
---
 documents/README.md        |  2 +-
 documents/bundles.md       |  2 +-
 documents/subprojects.md   | 17 +++++++++--------
 libs/promises/README.md    |  2 +-
 libs/pushstreams/README.md |  4 ++--
 5 files changed, 14 insertions(+), 13 deletions(-)

diff --git a/documents/README.md b/documents/README.md
index 96fccdf3..85e2806b 100644
--- a/documents/README.md
+++ b/documents/README.md
@@ -77,7 +77,7 @@ bundles contains binaries depending on the stdlibc++ library.
 ## More information
 
 * Building
-  * [Building and Installing Apache Celix](building)
+  * [Building and Installing Apache Celix](building/README.md)
   * [Building and Developing Apache Celix with CLion](building/dev_celix_with_clion.md)
 * Framework 
   * [Apache Celix Bundles](bundles.md)
diff --git a/documents/bundles.md b/documents/bundles.md
index 908442eb..53ece99b 100644
--- a/documents/bundles.md
+++ b/documents/bundles.md
@@ -286,7 +286,7 @@ add_celix_container(test_container BUNDLES
 )
 ```
 
-See [Apache Celix CMake Commands](cmake_commands) for more detailed information.
+See [Apache Celix CMake Commands](cmake_commands/README.md) for more detailed information.
 
 # The `celix::lb` shell command
 To interactively see the installed bundles the `celix::lb` shell command (list bundles) can be used.
diff --git a/documents/subprojects.md b/documents/subprojects.md
index dee38fcf..8529a67b 100644
--- a/documents/subprojects.md
+++ b/documents/subprojects.md
@@ -24,17 +24,18 @@ limitations under the License.
 Apache Celix is organized into several subprojects. The following subproject are available:
 
 * [Framework](../libs/framework) - The Apache Celix framework, an implementation of OSGi adapted to C and C++11.
-* [Utils](../libs/utils) - The Celix utils library, containing a wide range of utils functions (string, file, C hashmap, C arraylist, etc)
+* [Utils](../libs/utils/README.md) - The Celix utils library, containing a wide range of utils functions (string, file, C hashmap, C arraylist, etc)
 * [Examples](../examples) - A Selection of examples showing how the framework can be used.
-* [Log Service](../bundles/logging) - A Log Service logging abstraction for Apache Celix.
-* [Syslog Writer](../bundles/logging/log_writers/syslog_writer) - A syslog writer for use in combination with the Log Service.
+* [Log Service](../bundles/logging/README.md) - A Log Service logging abstraction for Apache Celix.
+  * [Syslog Writer](../bundles/logging/log_writers/syslog_writer) - A syslog writer for use in combination with the Log Service.
 * [Shell](../bundles/shell/README.md) - A OSGi C and C++11 shell implementation.
-* [Pubsub](../bundles/pubsub) - An implementation for a publish-subscribe remote message communication system. 
-* [HTTP Admin](../bundles/http_admin) - An implementation for the OSGi HTTP whiteboard adapted to C and based on civetweb.
+* [Pubsub](../bundles/pubsub/README.md) - An implementation for a publish-subscribe remote message communication system. 
+* [HTTP Admin](../bundles/http_admin/README.md) - An implementation for the OSGi HTTP whiteboard adapted to C and based on civetweb.
 * [Remote Services](../bundles/cxx_remote_services) - A C++17 adaption and implementation of the OSGi Remote Service Admin specification.
 
 Standalone libraries:
 
-* [Etcd library](../libs/etcdlib) - A C library that interfaces with ETCD.
-* [Promises library](../libs/promises) - A C++17 header only adaption and implementation of the OSGi Promise specification.
-* [Push Streams Library](../libs/pushstreams) - A C++17 header adaption and only implementation of the OSGi Push Stream specification. 
\ No newline at end of file
+* [Etcd library](../libs/etcdlib/README.md) - A C library that interfaces with ETCD.
+* [Promises library](../libs/promises/README.md) - A C++17 header only adaption and implementation of the OSGi Promise specification.
+* [Push Streams Library](../libs/pushstreams/README.md) - A C++17 header adaption and only implementation of the OSGi Push Stream specification. 
+
diff --git a/libs/promises/README.md b/libs/promises/README.md
index fd820673..de861098 100644
--- a/libs/promises/README.md
+++ b/libs/promises/README.md
@@ -13,7 +13,7 @@ NOTE: this implementation is still experiment and the api and behaviour will pro
 
 [OSGi Compendium Release 7 Promises Specification (HTML)](https://osgi.org/specification/osgi.cmpn/7.0.0/util.promise.html)
 
-[OSGi Compendium Release 7 Specification (PDF)](https://osgi.org/specification/osgi.cmpn/7.0.0/util.promise.html)
+[OSGi Compendium Release 7 Specification (PDF)](https://docs.osgi.org/download/r7/osgi.cmpn-7.0.0.pdf)
 
 ## Usage
 
diff --git a/libs/pushstreams/README.md b/libs/pushstreams/README.md
index 9a19e130..c1bc005c 100644
--- a/libs/pushstreams/README.md
+++ b/libs/pushstreams/README.md
@@ -11,9 +11,9 @@ NOTE: this implementation is still experiment and the api and behaviour will pro
 
 ## OSGi Information
 
-[OSGi Compendium Release 7 Promises Specification (HTML)](https://osgi.org/specification/osgi.cmpn/7.0.0/util.pushstream.html)
+[OSGi Compendium Release 7 Push Stream Specification (HTML)](https://osgi.org/specification/osgi.cmpn/7.0.0/util.pushstream.html)
 
-[OSGi Compendium Release 7 Specification (PDF)](https://osgi.org/specification/osgi.cmpn/7.0.0/util.pushstream.html)
+[OSGi Compendium Release 7 Specification (PDF)](https://docs.osgi.org/download/r7/osgi.cmpn-7.0.0.pdf)
 
 ## Usage