Merge branch 'master' into iox-eclipse-iceoryx#409-axivion-analysis

ApexAI · Feb 15, 2021 · 01f4fb2 · 01f4fb2
2 parents a24c55d + 77375bc
commit 01f4fb2
Show file tree

Hide file tree

Showing 837 changed files with 3,618 additions and 1,910 deletions.
diff --git a/.github/workflows/colcon.yml b/.github/workflows/colcon.yml
@@ -43,7 +43,10 @@ jobs:
         run: |
           source /opt/ros/foxy/setup.bash
           cd $GITHUB_WORKSPACE
-          ament_copyright --exclude LICENSE CONTRIBUTING.md
+          sudo rm -rf /opt/ros/foxy/lib/python3.8/site-packages/ament_copyright/template/apache2_header.txt
+          sudo cp -rf $GITHUB_WORKSPACE/tools/apache2_header.txt /opt/ros/foxy/lib/python3.8/site-packages/ament_copyright/template/.
+          sudo sed -i '41 c\"'c'", "'cc'", "'cpp'", "'cxx'", "'h'", "'hh'", "'hpp'", "'hxx'", "'inl'", "'sh'"' /opt/ros/foxy/lib/python3.8/site-packages/ament_copyright/main.py
+          ament_copyright --exclude LICENSE CONTRIBUTING.md tools/apache2_header.txt
 
       - name: Build & Test
         run: |

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -99,11 +99,11 @@ See [error-handling.md](./doc/error-handling.md) for additional information abou
 Please use [doxygen](http://www.doxygen.nl/) to document your code.
 
 The following doxygen comments are required for public API headers:
-
+```cpp
     /// @brief short description
     /// @param[in] / [out] / [in,out] name description
     /// @return description
-
+```
 A good example for code formatting and doxygen structure is at [swe_docu_guidelines.md (WIP)](./doc/aspice_swe3_4/swe_docu_guidelines.md)
 
 ## Folder structure
@@ -127,6 +127,8 @@ All new code should follow the folder structure.
 We use [Google test](https://github.com/google/googletest) for our unit and integration tests. We require compatibility
 with the version 1.8.1.
 
+Have a look at our [best practice guidelines](./doc/website/advanced/best-practice-for-testing.md) for writing tests in iceoryx.
+
 ### Unit tests (aka module tests)
 
 Unit tests are black box tests that test the public interface of a class. They are required for all new code.
@@ -193,14 +195,14 @@ Github [labels](https://github.com/eclipse-iceoryx/iceoryx/labels) are used to g
 If one of the rules is not followed, a rationale is added in the following manner:
 
 With a comment in the same line:
-
+```cpp
     *mynullptr = foo; // PRQA S 4242 # Short description why
-
+```
 With a comment one line above (with the number after the warning number, next ’n’ lines are inclusive)
-
+```cpp
     // PRQA S 4242 1 # Short description why
     *mynullptr = foo;
-
+```
 Don't be afraid if you don't have Helix QAC++ available. As we want to make it easy for developers to contribute,
 please use the ``staging`` branch and we'll run the QAC++ scan and get back to you.
 
@@ -215,8 +217,8 @@ requests. We're planning to introduce continuos integration checks in the near f
 
 Each source file needs to have this header:
 
-```
-    // Copyright (c) [DATE] by [INITIAL COPYRIGHT OWNER] [OTHER COPYRIGHT OWNERS]. All rights reserved.
+```cpp
+    // Copyright (c) [YEAR OF INITIAL CONTRIBUTION] - [YEAR LAST CONTRIBUTION] by [CONTRIBUTOR]. All rights reserved.
     //
     // Licensed under the Apache License, Version 2.0 (the "License");
     // you may not use this file except in compliance with the License.
@@ -229,13 +231,16 @@ Each source file needs to have this header:
     // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     // See the License for the specific language governing permissions and
     // limitations under the License.
+    //
+    // SPDX-License-Identifier: Apache-2.0
 ```
-Note: `DATE` is either a year or a range of years with the first and last years of the range separated by a comma. So for example: "2004" or "2000, 2004". The first year is when the contents of the file were first created and the last year is when the contents were last modified.
+Note: The date is either a year or a range of years with the first and last years of the range separated by a dash. For example: "2004" (initial and last contribution in the same year) or "2000 - 2004". The first year is when the contents of the file were first created and the last year is when the contents were last modified. The years of contribution should be ordered in chronological order, thus the last date in the list should be the year of the most recent contribution. If there is a gap between contributions of one or more calendar years, use a comma to separate the disconnected contribution periods (e.g. "2000 - 2004, 2006").
 
 Example:
 
-```
-    // Copyright (c) 2018, 2020 by ACME Corp, Globex. All rights reserved.
+```cpp
+    // Copyright (c) 2019 - 2020, 2022 by Acme Corporation. All rights reserved.
+    // Copyright (c) 2020 - 2022 by Jane Doe <jane@example.com>. All rights reserved.
     //
     // Licensed under the Apache License, Version 2.0 (the "License");
     // you may not use this file except in compliance with the License.
@@ -248,8 +253,10 @@ Example:
     // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     // See the License for the specific language governing permissions and
     // limitations under the License.
+    //
+    // SPDX-License-Identifier: Apache-2.0
 ```
-
+**_NOTE:_**  For scripts or CMake files you can use the respective comment syntax like `#` for the header.
 ## Quality levels
 
 CMake targets can be developed according to different quality levels. Despite developing some of our targets according

diff --git a/cmake/cpptoml/CMakeLists.txt b/cmake/cpptoml/CMakeLists.txt
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 project(cpptoml-build CXX)
 

diff --git a/cmake/cpptoml/cpptoml.cmake.in b/cmake/cpptoml/cpptoml.cmake.in
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.5)
 

diff --git a/cmake/cyclonedds/CMakeLists.txt b/cmake/cyclonedds/CMakeLists.txt
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 project(cyclonedds-build CXX)
 

diff --git a/cmake/cyclonedds/cyclonedds-cxx.cmake.in b/cmake/cyclonedds/cyclonedds-cxx.cmake.in
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 
 project(cyclonedds-cxx-download NONE)

diff --git a/cmake/cyclonedds/cyclonedds.cmake.in b/cmake/cyclonedds/cyclonedds.cmake.in
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 
 project(cyclonedds-download NONE)

diff --git a/cmake/cyclonedds/idlpp-cxx.cmake.in b/cmake/cyclonedds/idlpp-cxx.cmake.in
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 
 project(idlpp-cxx-download NONE)

diff --git a/cmake/googletest/CMakeLists.txt b/cmake/googletest/CMakeLists.txt
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 project(googletest-build CXX)
 

diff --git a/cmake/googletest/googletest.cmake.in b/cmake/googletest/googletest.cmake.in
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.5)
 

diff --git a/cmake/package/package.cmake b/cmake/package/package.cmake
@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 file (STRINGS "../VERSION" iceoryx_VERSION)
 project(iceoryx-package)

diff --git a/cpptoml_vendor/CMakeLists.txt b/cpptoml_vendor/CMakeLists.txt
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.5)
 project(cpptoml_vendor)

diff --git a/cpptoml_vendor/cpptoml_vendorConfig.cmake.in b/cpptoml_vendor/cpptoml_vendorConfig.cmake.in
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 # include cpptoml config file to make find_package(cpptoml REQUIRED) work
 

diff --git a/cpptoml_vendor/cpptoml_vendorConfigVersion.cmake.in b/cpptoml_vendor/cpptoml_vendorConfigVersion.cmake.in
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 set(PACKAGE_VERSION "@cpptoml_vendor_VERSION@")
 

diff --git a/doc/aspice_swe3_4/CMakeLists.txt b/doc/aspice_swe3_4/CMakeLists.txt
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.10)
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/CMakeLists.txt b/doc/aspice_swe3_4/example/iceoryx_component/CMakeLists.txt
@@ -11,6 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.5)
 project(iceoryx_component VERSION 0.8.15)

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/include/example_component.hpp b/doc/aspice_swe3_4/example/iceoryx_component/include/example_component.hpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 #ifndef IOX_DOC_EXAMPLE_COMPONENT_EXAMPLE_COMPONENT_HPP
 #define IOX_DOC_EXAMPLE_COMPONENT_EXAMPLE_COMPONENT_HPP
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/include/example_module/example_derived_class.hpp b/doc/aspice_swe3_4/example/iceoryx_component/include/example_module/example_derived_class.hpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 #ifndef IOX_DOC_EXAMPLE_MODULE_EXAMPLE_DERIVED_CLASS_HPP
 #define IOX_DOC_EXAMPLE_MODULE_EXAMPLE_DERIVED_CLASS_HPP
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.cpp b/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.cpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 
 #include "example_base_class.hpp"
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.hpp b/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.hpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 #ifndef IOX_DOC_EXAMPLE_MODULE_EXAMPLE_BASE_CLASS_HPP
 #define IOX_DOC_EXAMPLE_MODULE_EXAMPLE_BASE_CLASS_HPP
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.inl b/doc/aspice_swe3_4/example/iceoryx_component/source/example_module/example_base_class.inl
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 #ifndef EXAMPLE_BASE_CLASS_INL_INCLUDED
 #define EXAMPLE_BASE_CLASS_INL_INCLUDED
 

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/test/moduletests/test_component_modules.cpp b/doc/aspice_swe3_4/example/iceoryx_component/test/moduletests/test_component_modules.cpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>

diff --git a/doc/aspice_swe3_4/example/iceoryx_component/test/moduletests/test_example_base_class.cpp b/doc/aspice_swe3_4/example/iceoryx_component/test/moduletests/test_example_base_class.cpp
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 
 #include "example_base_class.hpp"
 

diff --git a/doc/design/fixedString.adoc b/doc/design/fixedString.adoc
@@ -11,6 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
 
 == Fixed string implementation
 This document is intended to provide an overview of the fixed string implementation. The fixed string will be implemented in three steps. The first and second step are already completed and include: