Iox #482 rework overview

CHANGELOG.md

@@ -54,6 +54,30 @@ See [Eclipse iceoryx 1.0.0 (Almond)](https://projects.eclipse.org/projects/techn
 - iceoryx libs should be build as static libs [\#509](https://github.com/eclipse-iceoryx/iceoryx/issues/509)
 - Build with gcov is broken [\#497](https://github.com/eclipse-iceoryx/iceoryx/issues/497)
 
+## [v0.99.x](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.99.x) (2021-04-xx)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.99.6...v0.99.x)
+
+- cleanup testing libraries; if used outside of iceoryx, include paths and link targets must be adjusted
+
+## [v0.99.6](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.99.6) (2021-04-08)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.99.5...v0.99.6)
+
+- Add git to dependency list in iceoryx_posh for RHEL
+
+## [v0.99.5](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.99.5) (2021-04-08)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.99.4...v0.99.5)
+
+- Add libatomic to dependency list in iceoryx_utils for RHEL
+
+## [v0.99.4](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.99.4) (2021-04-06)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.99.3...v0.99.4)
+
+- Increase version number to trigger build again on ROS buildfarm
+
 ## [v0.99.3](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.99.3) (2021-04-06)
 
 [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.99.2...v0.99.3)
@@ -71,6 +95,7 @@ See [Eclipse iceoryx 1.0.0 (Almond)](https://projects.eclipse.org/projects/techn
 [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.90.0...v0.99.0)
 
 Intermediate Milestone before the final 1.0.0 release, see v.1.0.0 above for the changes.
+
 ## [v0.90.0](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.90.0) (2020-12-22)
 
 [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.17.0...v0.90.0)

CONTRIBUTING.md

@@ -70,7 +70,7 @@ codebase follows these rules, things are work in progress.
 
 1) **No heap is allowed**, static memory management hugely decreases the complexity of your software (e.g. cxx::vector
     without heap)
-2) **No exception are allowed**, all function and methods need to have `noexcept` in their signature
+2) **No exceptions are allowed**, all function and methods need to have `noexcept` in their signature
 3) **No undefined behavior**, zero-cost abstract is not feasible in high safety environments
 4) **Use C++14**
 5) **[Rule of Five](https://en.wikipedia.org/wiki/Rule_of_three_(C%2B%2B_programming))**, if there is a non-default
@@ -79,9 +79,11 @@ codebase follows these rules, things are work in progress.
     our code may contain additions which are not compatible with the STL (e.g. `iox::cxx::vector::emplace_back()`
     does return a bool)
 7) **Always use `iox::log::Logger`**, instead of `printf()`
-8) **Always use `iox::ErrorHandler()`**, instead of the direct STL calls
+8) **Always use `iox::ErrorHandler()`**, when an error occurs that cannot or shall not be propagated via an 
+    `iox::cxx::expected`, the `iox::ErrorHandler()` shall be used; exceptions are not allowed
 
-See [error-handling.md](./doc/error-handling.md) for additional information about logging and error handling.
+See [error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/design/error-handling.md) for additional 
+information about logging and error handling.
 
 ### Naming conventions
 

VERSION

@@ -1 +1 @@
-0.99.3
+0.99.6

cmake/package/package.cmake

@@ -14,7 +14,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
-set(IOX_VERSION_STRING "0.99.3")
+set(IOX_VERSION_STRING "0.99.6")
 #find_package(iceoryx_utils REQUIRED)
 
 #include(IceoryxVersion)

doc/aspice_swe3_4/CMakeLists.txt

@@ -16,7 +16,7 @@
 
 cmake_minimum_required(VERSION 3.10)
 
-set(IOX_VERSION_STRING "0.99.3")
+set(IOX_VERSION_STRING "0.99.6")
 
 #find_package(iceoryx_utils REQUIRED)
 

doc/aspice_swe3_4/swe_docu_guidelines.md

@@ -61,8 +61,8 @@ Here we provide a list with the most usual tags in iceoryx:
 ### Custom Tags
 In iceoryx are also custom tags used for extended documentation like errors.
  - `/// @concurrent` use this tag if the code is used in multithreading context for comments about it
- - `/// @req` used to set links to a database with requirements, see [iceoryx_component.hpp](example/iceoryx_component/include/iceoryx_component.hpp)
- - `/// @link` used to set general links additional information, see [iceoryx_component.hpp](example/iceoryx_component/include/iceoryx_component.hpp)
+ - `/// @req` used to set links to a database with requirements, see [iceoryx_component.hpp](example/iceoryx_component/include/example_component.hpp)
+ - `/// @link` used to set general links additional information, see [iceoryx_component.hpp](example/iceoryx_component/include/example_component.hpp)
  - `/// @swcomponent` marks the relationship to the component
  - `/// @error` used for describing the error behavior e.g. error-handler is called
  - `/// @generatedcode` for marking code as generated
@@ -122,4 +122,4 @@ If you want to download the pdf files from the Pull-Requests or master build you
 
  * Open the "Checks" view in the PR
  * Open the "Details" link for the check `iceoryx-coverage-doxygen-ubuntu` in `Test Coverage + Doxygen Documentation`
- * On the right side you find a menu button `Artifacts` which shows `iceoryx-pdf` as download link
+ * On the right side you find a menu button `Artifacts` which shows `iceoryx-pdf` as download link

doc/goals-non-goals.md

@@ -46,4 +46,4 @@ that slow self-made IPC to communicate with his sensors because his parents want
 makes it hard for him to react in real-time to dangerous incidents like flying coffee cups. When strolling through
 the interwebs on a lonely evening, he finds out about iceoryx: Free-to-use, high-performance data transfer with low
 runtime overhead, real-time support! Brilliant! Maybe even Robby's biggest wish for a network binding will come true,
-so he can stream his favorite [video](https://www.youtube.com/watch?v=g5NkgZXWl0w) even faster!
+so he can stream his favorite videos even faster!