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 e4409e8311145b46dc73e87d2c423e9f2ed89881 Author: Roy Lenferink <lenferink...@gmail.com> AuthorDate: Sun Jul 7 14:36:35 2019 +0200 Updated script to extract docs from Celix --- extract_celix_docs.sh | 5 +++-- source/docs/celix/CHANGES.md | 1 - source/docs/celix/README.md | 1 - source/docs/celix/config_admin/readme.md | 1 - source/docs/celix/dependency_manager/readme.md | 1 - source/docs/celix/dependency_manager_cxx/readme.md | 1 - source/docs/celix/deployment_admin/README.md | 1 - source/docs/celix/device_access/README.md | 1 - source/docs/celix/documents/building/readme.md | 1 - source/docs/celix/documents/cmake_commands/readme.md | 1 - .../docs/celix/documents/getting_started/creating_a_simple_bundle.md | 1 - source/docs/celix/documents/getting_started/readme.md | 1 - source/docs/celix/documents/getting_started/using_services_with_c.md | 1 - .../docs/celix/documents/getting_started/using_services_with_cxx.md | 1 - source/docs/celix/documents/intro/readme.md | 1 - source/docs/celix/documents/roadmap/api_v3/readme.md | 3 +-- source/docs/celix/documents/roadmap/improvement_ideas.md | 1 - source/docs/celix/documents/roadmap/roadmap.md | 1 - source/docs/celix/etcdlib/README.md | 1 - source/docs/celix/launcher/README.md | 1 - source/docs/celix/log_service/README.md | 1 - source/docs/celix/log_writer/README.md | 1 - source/docs/celix/pubsub/README.md | 1 - source/docs/celix/pubsub/examples/keys/README.md | 1 - source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md | 1 - source/docs/celix/remote_services/README.md | 1 - source/docs/celix/remote_services/discovery_etcd/README.md | 1 - source/docs/celix/remote_services/remote_service_admin/README.md | 1 - source/docs/celix/remote_services/topology_manager/README.md | 1 - source/docs/celix/remote_shell/README.md | 1 - source/docs/celix/shell/README.md | 1 - source/docs/celix/shell_tui/README.md | 1 - source/docs/celix/utils/README.md | 1 - source/docs/celix/utils/docs/thpool/Design.md | 1 - source/docs/celix/utils/docs/thpool/FAQ.md | 1 - source/docs/celix/utils/docs/thpool/README.md | 1 - source/docs/celix/utils/public/include/memstream/README.md | 1 - 37 files changed, 4 insertions(+), 39 deletions(-) diff --git a/extract_celix_docs.sh b/extract_celix_docs.sh index d7ff47d..542c597 100644 --- a/extract_celix_docs.sh +++ b/extract_celix_docs.sh @@ -33,9 +33,10 @@ for FILE_PATH in $(cd ${CELIX_SRC_DIR}; find . -name \*.md); do cp -v ${CELIX_SRC_DIR}/${FILE_PATH} ${CELIX_DOC_DIR}/${FILE_DIR} # Prepend markdown file with Hugo header - SECOND_LINE=$(head -n 2 ${FILE_PATH} | tail -n 1) + DEST_FILE=${CELIX_DOC_DIR}/${FILE_PATH} + SECOND_LINE=$(head -n 2 ${DEST_FILE} | tail -n 1) if [[ "${SECOND_LINE}" != *"type: celix-doc"* ]]; then - sed -i '1s;^;---\ntype: celix-doc\ntitle: ${FILE_NAME}\n---\n\n;' ${FILE_PATH} + sed -i "1s;^;---\ntype: celix-doc\ntitle: ${FILE_NAME}\n---\n\n;" ${DEST_FILE} fi done diff --git a/source/docs/celix/CHANGES.md b/source/docs/celix/CHANGES.md index 46fc02d..d372e20 100644 --- a/source/docs/celix/CHANGES.md +++ b/source/docs/celix/CHANGES.md @@ -3,7 +3,6 @@ type: celix-doc title: CHANGES.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/README.md b/source/docs/celix/README.md index 50b12ed..575ee6e 100644 --- a/source/docs/celix/README.md +++ b/source/docs/celix/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 diff --git a/source/docs/celix/config_admin/readme.md b/source/docs/celix/config_admin/readme.md index 03af413..bcdbc13 100644 --- a/source/docs/celix/config_admin/readme.md +++ b/source/docs/celix/config_admin/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 diff --git a/source/docs/celix/dependency_manager/readme.md b/source/docs/celix/dependency_manager/readme.md index 0b484a7..7b2a9c8 100644 --- a/source/docs/celix/dependency_manager/readme.md +++ b/source/docs/celix/dependency_manager/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 diff --git a/source/docs/celix/dependency_manager_cxx/readme.md b/source/docs/celix/dependency_manager_cxx/readme.md index ed90b36..9a31719 100644 --- a/source/docs/celix/dependency_manager_cxx/readme.md +++ b/source/docs/celix/dependency_manager_cxx/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 diff --git a/source/docs/celix/deployment_admin/README.md b/source/docs/celix/deployment_admin/README.md index 52f7031..d1e60c4 100644 --- a/source/docs/celix/deployment_admin/README.md +++ b/source/docs/celix/deployment_admin/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 diff --git a/source/docs/celix/device_access/README.md b/source/docs/celix/device_access/README.md index a9840cd..bdd7467 100644 --- a/source/docs/celix/device_access/README.md +++ b/source/docs/celix/device_access/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 diff --git a/source/docs/celix/documents/building/readme.md b/source/docs/celix/documents/building/readme.md index 86cc13e..2a9f2b1 100644 --- a/source/docs/celix/documents/building/readme.md +++ b/source/docs/celix/documents/building/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 diff --git a/source/docs/celix/documents/cmake_commands/readme.md b/source/docs/celix/documents/cmake_commands/readme.md index fe74f70..772ccc6 100644 --- a/source/docs/celix/documents/cmake_commands/readme.md +++ b/source/docs/celix/documents/cmake_commands/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 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 231dc08..34cbb30 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 @@ -3,7 +3,6 @@ type: celix-doc title: creating_a_simple_bundle.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/documents/getting_started/readme.md b/source/docs/celix/documents/getting_started/readme.md index e53644b..53eb948 100644 --- a/source/docs/celix/documents/getting_started/readme.md +++ b/source/docs/celix/documents/getting_started/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 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 6ad0fa1..e61b24a 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 @@ -3,7 +3,6 @@ type: celix-doc title: using_services_with_c.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with 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 96fb3d5..e889263 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 @@ -3,7 +3,6 @@ type: celix-doc title: using_services_with_cxx.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/documents/intro/readme.md b/source/docs/celix/documents/intro/readme.md index eb79672..2696b40 100644 --- a/source/docs/celix/documents/intro/readme.md +++ b/source/docs/celix/documents/intro/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 diff --git a/source/docs/celix/documents/roadmap/api_v3/readme.md b/source/docs/celix/documents/roadmap/api_v3/readme.md index 576e4dd..1bae2d3 100644 --- a/source/docs/celix/documents/roadmap/api_v3/readme.md +++ b/source/docs/celix/documents/roadmap/api_v3/readme.md @@ -3,8 +3,7 @@ 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 this work for additional information regarding copyright ownership. diff --git a/source/docs/celix/documents/roadmap/improvement_ideas.md b/source/docs/celix/documents/roadmap/improvement_ideas.md index 1cf877c..a411598 100644 --- a/source/docs/celix/documents/roadmap/improvement_ideas.md +++ b/source/docs/celix/documents/roadmap/improvement_ideas.md @@ -3,7 +3,6 @@ type: celix-doc title: improvement_ideas.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/documents/roadmap/roadmap.md b/source/docs/celix/documents/roadmap/roadmap.md index a5896e4..30c3ebb 100644 --- a/source/docs/celix/documents/roadmap/roadmap.md +++ b/source/docs/celix/documents/roadmap/roadmap.md @@ -3,7 +3,6 @@ type: celix-doc title: roadmap.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/etcdlib/README.md b/source/docs/celix/etcdlib/README.md index 06592b1..8fbe866 100644 --- a/source/docs/celix/etcdlib/README.md +++ b/source/docs/celix/etcdlib/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 diff --git a/source/docs/celix/launcher/README.md b/source/docs/celix/launcher/README.md index 09d5b07..b1812ef 100644 --- a/source/docs/celix/launcher/README.md +++ b/source/docs/celix/launcher/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 diff --git a/source/docs/celix/log_service/README.md b/source/docs/celix/log_service/README.md index ff17d08..f51fae9 100644 --- a/source/docs/celix/log_service/README.md +++ b/source/docs/celix/log_service/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 diff --git a/source/docs/celix/log_writer/README.md b/source/docs/celix/log_writer/README.md index d2e990a..01a69c8 100644 --- a/source/docs/celix/log_writer/README.md +++ b/source/docs/celix/log_writer/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 diff --git a/source/docs/celix/pubsub/README.md b/source/docs/celix/pubsub/README.md index 5cc3cfe..83fa8b4 100644 --- a/source/docs/celix/pubsub/README.md +++ b/source/docs/celix/pubsub/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 diff --git a/source/docs/celix/pubsub/examples/keys/README.md b/source/docs/celix/pubsub/examples/keys/README.md index a35695c..ee1300e 100644 --- a/source/docs/celix/pubsub/examples/keys/README.md +++ b/source/docs/celix/pubsub/examples/keys/README.md @@ -4,7 +4,6 @@ title: README.md --- - <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with diff --git a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md b/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md index 565ef6f..8fd0ada 100644 --- a/source/docs/celix/pubsub/pubsub_admin_udp_mc/README.md +++ b/source/docs/celix/pubsub/pubsub_admin_udp_mc/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 diff --git a/source/docs/celix/remote_services/README.md b/source/docs/celix/remote_services/README.md index 5050bd0..bd9ac95 100644 --- a/source/docs/celix/remote_services/README.md +++ b/source/docs/celix/remote_services/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 diff --git a/source/docs/celix/remote_services/discovery_etcd/README.md b/source/docs/celix/remote_services/discovery_etcd/README.md index b5829d2..6ea6f7a 100644 --- a/source/docs/celix/remote_services/discovery_etcd/README.md +++ b/source/docs/celix/remote_services/discovery_etcd/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 diff --git a/source/docs/celix/remote_services/remote_service_admin/README.md b/source/docs/celix/remote_services/remote_service_admin/README.md index 4abc94a..f620015 100644 --- a/source/docs/celix/remote_services/remote_service_admin/README.md +++ b/source/docs/celix/remote_services/remote_service_admin/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 diff --git a/source/docs/celix/remote_services/topology_manager/README.md b/source/docs/celix/remote_services/topology_manager/README.md index bae7405..f75059c 100644 --- a/source/docs/celix/remote_services/topology_manager/README.md +++ b/source/docs/celix/remote_services/topology_manager/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 diff --git a/source/docs/celix/remote_shell/README.md b/source/docs/celix/remote_shell/README.md index fd8cd8b..bf1eb8a 100644 --- a/source/docs/celix/remote_shell/README.md +++ b/source/docs/celix/remote_shell/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 diff --git a/source/docs/celix/shell/README.md b/source/docs/celix/shell/README.md index df6a60f..e680d92 100644 --- a/source/docs/celix/shell/README.md +++ b/source/docs/celix/shell/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 diff --git a/source/docs/celix/shell_tui/README.md b/source/docs/celix/shell_tui/README.md index 164d258..559004c 100644 --- a/source/docs/celix/shell_tui/README.md +++ b/source/docs/celix/shell_tui/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 diff --git a/source/docs/celix/utils/README.md b/source/docs/celix/utils/README.md index b8e58b6..3cec0fc 100644 --- a/source/docs/celix/utils/README.md +++ b/source/docs/celix/utils/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 diff --git a/source/docs/celix/utils/docs/thpool/Design.md b/source/docs/celix/utils/docs/thpool/Design.md index 20705ca..2908f86 100644 --- a/source/docs/celix/utils/docs/thpool/Design.md +++ b/source/docs/celix/utils/docs/thpool/Design.md @@ -3,7 +3,6 @@ type: celix-doc title: Design.md --- - ## High level Description: Library providing a threading pool where you can add work on the fly. The number diff --git a/source/docs/celix/utils/docs/thpool/FAQ.md b/source/docs/celix/utils/docs/thpool/FAQ.md index 7a9c2e6..7ef617d 100644 --- a/source/docs/celix/utils/docs/thpool/FAQ.md +++ b/source/docs/celix/utils/docs/thpool/FAQ.md @@ -4,7 +4,6 @@ title: FAQ.md --- - ### Why isn't pthread_exit() used to exit a thread? `thread_do` used to use pthread_exit(). However that resulted in hard times of testing for memory leaks. The reason is that on pthread_exit() diff --git a/source/docs/celix/utils/docs/thpool/README.md b/source/docs/celix/utils/docs/thpool/README.md index d0fe29b..31d86b1 100644 --- a/source/docs/celix/utils/docs/thpool/README.md +++ b/source/docs/celix/utils/docs/thpool/README.md @@ -3,7 +3,6 @@ type: celix-doc title: README.md --- -  # C Thread Pool diff --git a/source/docs/celix/utils/public/include/memstream/README.md b/source/docs/celix/utils/public/include/memstream/README.md index 3e5fcaf..4058c0b 100644 --- a/source/docs/celix/utils/public/include/memstream/README.md +++ b/source/docs/celix/utils/public/include/memstream/README.md @@ -3,7 +3,6 @@ type: celix-doc title: README.md --- - fmemopen for Mac OS and iOS ===========================