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 2019/07/12 17:52:23 UTC
[celix-site] 32/34: Updated extract_celix_docs script to update
Markdown to HTML links
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
commit f0c4279e88bd9fbf372dadbe683f6204d1882470
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Sun Jul 7 14:54:56 2019 +0200
Updated extract_celix_docs script to update Markdown to HTML links
---
extract_celix_docs.sh | 3 +++
source/docs/celix/README.md | 6 ++---
source/docs/celix/dependency_manager/readme.md | 2 +-
source/docs/celix/dependency_manager_cxx/readme.md | 4 +--
source/docs/celix/documents/building/readme.md | 2 +-
.../getting_started/creating_a_simple_bundle.md | 8 +++---
.../docs/celix/documents/getting_started/readme.md | 6 ++---
.../getting_started/using_services_with_c.md | 2 +-
.../getting_started/using_services_with_cxx.md | 2 +-
source/docs/celix/documents/intro/readme.md | 12 ++++-----
source/docs/celix/documents/subprojects/readme.md | 29 +++++++++++-----------
source/docs/celix/remote_services/README.md | 4 +--
12 files changed, 41 insertions(+), 39 deletions(-)
diff --git a/extract_celix_docs.sh b/extract_celix_docs.sh
index 542c597..f873f25 100644
--- a/extract_celix_docs.sh
+++ b/extract_celix_docs.sh
@@ -39,4 +39,7 @@ for FILE_PATH in $(cd ${CELIX_SRC_DIR}; find . -name \*.md); do
if [[ "${SECOND_LINE}" != *"type: celix-doc"* ]]; then
sed -i "1s;^;---\ntype: celix-doc\ntitle: ${FILE_NAME}\n---\n\n;" ${DEST_FILE}
fi
+
+ # Replace markdown links with HTML links
+ sed -i "s/.md)/.html)/" ${DEST_FILE}
done
diff --git a/source/docs/celix/README.md b/source/docs/celix/README.md
index 575ee6e..f3a40be 100644
--- a/source/docs/celix/README.md
+++ b/source/docs/celix/README.md
@@ -24,11 +24,11 @@ limitations under the License.
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.
## Building
-For information how to build Apache Celix see [Building Apache Celix](documents/building/readme.md)
+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.md)
+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.md)
+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/dependency_manager/readme.md b/source/docs/celix/dependency_manager/readme.md
index 7b2a9c8..fa1198f 100644
--- a/source/docs/celix/dependency_manager/readme.md
+++ b/source/docs/celix/dependency_manager/readme.md
@@ -148,5 +148,5 @@ their state, provided interfaces and required interfaces.
For more information examples please see
- [The Dependency Manager API](public/include): The dependency manager header files
-- [Getting Started: Using Service with C](../documents/getting_started/using_services_with_c.md): A introduction how to work with services using the dependency manager
+- [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.
diff --git a/source/docs/celix/dependency_manager_cxx/readme.md b/source/docs/celix/dependency_manager_cxx/readme.md
index 9a31719..9c09ff6 100644
--- a/source/docs/celix/dependency_manager_cxx/readme.md
+++ b/source/docs/celix/dependency_manager_cxx/readme.md
@@ -32,7 +32,7 @@ The C++ Dependency Manager uses fluent interface to make specifying DM component
## C++ and C Dependency Manager
The C++ Dependency Manager is build on top of the C Dependency Manager.
-To get a good overview of the C++ Dependency Manager please read the [Dependency Manager documentation](../dependency_manager/README.md)
+To get a good overview of the C++ Dependency Manager please read the [Dependency Manager documentation](../dependency_manager/README.html)
## DM Parts
@@ -80,4 +80,4 @@ 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.md): A introduction how to work with services using the C++ dependency manager
+- [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
diff --git a/source/docs/celix/documents/building/readme.md b/source/docs/celix/documents/building/readme.md
index 2a9f2b1..3d914e1 100644
--- a/source/docs/celix/documents/building/readme.md
+++ b/source/docs/celix/documents/building/readme.md
@@ -140,4 +140,4 @@ 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.md).
+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/celix/documents/getting_started/creating_a_simple_bundle.md b/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
index 34cbb30..dd5af6b 100644
--- a/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
+++ b/source/docs/celix/documents/getting_started/creating_a_simple_bundle.md
@@ -31,7 +31,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.md)
+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 [...]
@@ -324,13 +324,13 @@ 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.md)
+ - [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.md)
-- [Apache Celix - Getting Started Guide: Using Services with C++](using_services_with_cxx.md)
+- [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/readme.md b/source/docs/celix/documents/getting_started/readme.md
index 53eb948..b3cfd9e 100644
--- a/source/docs/celix/documents/getting_started/readme.md
+++ b/source/docs/celix/documents/getting_started/readme.md
@@ -23,9 +23,9 @@ limitations under the License.
# Apache Celix - Getting Started Guide
## Guides
-There are several guide to help you get started. The first guide is [Getting Started: Creating a simple bundle](creating_a_simple_bundle.md)
+There are several guide to help you get started. The first guide is [Getting Started: Creating a simple bundle](creating_a_simple_bundle.html)
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.md)
- - [Getting Started: Using Services with C++](using_services_with_cxx.md).
+ - [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/using_services_with_c.md b/source/docs/celix/documents/getting_started/using_services_with_c.md
index e61b24a..7520154 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_c.md
+++ b/source/docs/celix/documents/getting_started/using_services_with_c.md
@@ -612,4 +612,4 @@ The suspend strategy has the advantage of reducing locks' usage: of course, susp
## See also
-See the [C Dependeny Manager](../../dependency_manager/readme.md) and [C Dependency Manager example](../../examples/dm_example) for more information and a more complex working example.
+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.
diff --git a/source/docs/celix/documents/getting_started/using_services_with_cxx.md b/source/docs/celix/documents/getting_started/using_services_with_cxx.md
index e889263..4669713 100644
--- a/source/docs/celix/documents/getting_started/using_services_with_cxx.md
+++ b/source/docs/celix/documents/getting_started/using_services_with_cxx.md
@@ -573,4 +573,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.md) and [C++ Dependency Manager example](../../examples/dm_example_cxx) for more information and a more complex working example.
+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.
diff --git a/source/docs/celix/documents/intro/readme.md b/source/docs/celix/documents/intro/readme.md
index 2696b40..90a9e04 100644
--- a/source/docs/celix/documents/intro/readme.md
+++ b/source/docs/celix/documents/intro/readme.md
@@ -128,7 +128,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 - Getting Started Guide](https://github.com/apache/celix/blob/master/documents/getting_started/readme.md) for a more in depth look at services and service usage.
+See [Apache Celix - Getting Started Guide](https://github.com/apache/celix/blob/master/documents/getting_started/readme.html) 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.
@@ -142,20 +142,20 @@ 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.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.
+* [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.
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.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.md)
-* [Apache Celix - Getting Started Guide](../getting_started/readme.md)
-* [Apache Celix - CMake Commands](../cmake_commands/readme.md)
+* [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/celix/documents/subprojects/readme.md b/source/docs/celix/documents/subprojects/readme.md
index 4488cf6..dcfdd73 100644
--- a/source/docs/celix/documents/subprojects/readme.md
+++ b/source/docs/celix/documents/subprojects/readme.md
@@ -3,7 +3,6 @@ type: celix-doc
title: readme.md
---
-
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -26,24 +25,24 @@ limitations under the License.
Apache Celix is organized into several subprojects. The following subproject are currently available:
* [Framework](https://github.com/apache/celix/tree/rel/celix-2.1.0/framework) - The Apache Celix framework, an implementation of OSGi adapted to C.
-* [C Dependency Manager](../../dependency_manager/readme.md) - A C component/dependency model for use through an API provided as library.
-* [C++ Dependency Manager](../../dependency_manager_cxx/readme.md) - A C++ component/dependency model for use through an API provided as library.
-* [Device Access](../../device_access/README.md) - An implementation of the OSGi Device Access specification adapted to C.
-* [Etcd library](../../etcdlib/README.md) - A C library that interfaces with ETCD.
+* [C Dependency Manager](../../dependency_manager/readme.html) - A C component/dependency model for use through an API provided as library.
+* [C++ Dependency Manager](../../dependency_manager_cxx/readme.html) - A C++ component/dependency model for use through an API provided as library.
+* [Device Access](../../device_access/README.html) - An implementation of the OSGi Device Access specification adapted to C.
+* [Etcd library](../../etcdlib/README.html) - A C library that interfaces with ETCD.
* [Examples](https://github.com/apache/celix/tree/rel/celix-2.1.0/examples) - A Selection of examples showing how the framework can be used.
-* [Log Service](../../log_service/README.md) - An implementation of the OSGi Log Service adapated to C.
-* [Log Writer](../../log_writer/README.md) - A simple log writer for use in combination with the Log Service.
-* [Remote Service Admin](../../remote_services/README.md) - An implementation of the OSGi Remote Service Admin Service - for several protocols - adapted to C.
+* [Log Service](../../log_service/README.html) - An implementation of the OSGi Log Service adapated to C.
+* [Log Writer](../../log_writer/README.html) - A simple log writer for use in combination with the Log Service.
+* [Remote Service Admin](../../remote_services/README.html) - An implementation of the OSGi Remote Service Admin Service - for several protocols - adapted to C.
* [Remote Service Admin HTTP](https://github.com/apache/celix/tree/rel/celix-2.1.0/remote_services/remote_service_admin_http) - A HTTP implementation of the RSA.
* [Remote Service Admin DFI](https://github.com/apache/celix/tree/rel/celix-2.1.0/remote_services/remote_service_admin_dfi) - A Dynamic Function Interface (DFI) implementation of the RSA.
* [Remote Service Admin SHM](https://github.com/apache/celix/tree/rel/celix-2.1.0/remote_services/remote_service_admin_shm) - A shared memory implementation of the RSA.
- * [Topology Manager](../../remote_services/topology_manager/README.md) - A (scoped) RSA Topology Manager implementation.
+ * [Topology Manager](../../remote_services/topology_manager/README.html) - A (scoped) RSA Topology Manager implementation.
* [Discovery Configured](https://github.com/apache/celix/tree/rel/celix-2.1.0/remote_services/discovery_configured) - A RSA Discovery implementation using static configuration (xml).
- * [Discovery Etcd](../../remote_services/discovery_etcd/README.md) - A RSA Discovery implementation using etcd.
+ * [Discovery Etcd](../../remote_services/discovery_etcd/README.html) - A RSA Discovery implementation using etcd.
* [Discovery SHM](https://github.com/apache/celix/tree/rel/celix-2.1.0/remote_services/discovery_shm) - A RSA Discovery implementation using shared memory.
-* [Shell](../../shell/README.md) - A OSGi shell implementation.
-* [Shell TUI](../../shell_tui/README.md) - A textual UI for the Celix Shell.
-* [Remote Shell](../../remote_shell/README.md) - A remote (telnet) frontend for the Celix shell.
+* [Shell](../../shell/README.html) - A OSGi shell implementation.
+* [Shell TUI](../../shell_tui/README.html) - A textual UI for the Celix Shell.
+* [Remote Shell](../../remote_shell/README.html) - A remote (telnet) frontend for the Celix shell.
* [Bonjour Shell](https://github.com/apache/celix/tree/rel/celix-2.1.0/shell_bonjour) - A remote (Bonjour / mDNS) frontend for the Celix shell.
-* [Deployment Admin](../../deployment_admin/README.md) - A deployment admin implementation.
-* [Pubsub](../../pubsub/README.md) - An implementation for a publish-subscribe remote services system, that use dfi library for message serialization.
+* [Deployment Admin](../../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/remote_services/README.md b/source/docs/celix/remote_services/README.md
index bd9ac95..33c9d6c 100644
--- a/source/docs/celix/remote_services/README.md
+++ b/source/docs/celix/remote_services/README.md
@@ -90,7 +90,7 @@ Provides a service discovery with preconfigured discovery endpoints, allowing a
Note that for configured discovery, the "Endpoint Description Extender" XML format defined in the OSGi Remote Service Admin specification (section 122.8 of OSGi Enterprise 5.0.0) is used.
-See [etcd discovery](discovery_etcd/README.md)
+See [etcd discovery](discovery_etcd/README.html)
#### etcd discovery
@@ -98,7 +98,7 @@ See [etcd discovery](discovery_etcd/README.md)
Provides a service discovery using etcd distributd key/value store.
-See [etcd discovery](discovery_etcd/README.md)
+See [etcd discovery](discovery_etcd/README.html)
## Usage