Merge pull request #674 from rticommunity/feature/ROUTING-1182-to-develop

juanlu-rti · web-flow · commit d442de87ebcb · 2024-03-08T14:58:33.000+01:00
ROUTING-1182: adding cross-compilation instructions where missing for…
diff --git a/examples/cloud_discovery_service/library_api/c++11/README.md b/examples/cloud_discovery_service/library_api/c++11/README.md
@@ -112,6 +112,30 @@ you want to link against. For example:
 cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 ..
 ```
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ### CMake Build Infrastructure
 
 The `CMakeListst.txt` script that builds this example uses a generic CMake
diff --git a/examples/cloud_discovery_service/library_api/c/README.md b/examples/cloud_discovery_service/library_api/c/README.md
@@ -112,9 +112,33 @@ you want to link against. For example:
 cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 ..
 ```
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ### CMake Build Infrastructure
 
-The `CMakeListst.txt` script that builds this example uses a generic CMake
+The `CMakeLists.txt` script that builds this example uses a generic CMake
 function called `connextdds_add_example` that defines all the necessary constructs
 to:
 
diff --git a/examples/persistence_service/library_api/c/README.md b/examples/persistence_service/library_api/c/README.md
@@ -117,6 +117,30 @@ you want to link against. For example:
 cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 ..
 ```
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ### CMake Build Infrastructure
 
 The `CMakeListst.txt` script that builds this example uses a generic CMake
diff --git a/examples/persistence_service/persistent_storage/c++11/README.md b/examples/persistence_service/persistent_storage/c++11/README.md
@@ -226,6 +226,30 @@ you want to link against. For example:
 cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 ..
 ```
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ### CMake Build Infrastructure
 
 The `CMakeListst.txt` script that builds this example uses a generic CMake
diff --git a/examples/recording_service/pluggable_storage/c++11/README.md b/examples/recording_service/pluggable_storage/c++11/README.md
@@ -58,12 +58,20 @@ In order to build this example, you need to provide the following variables to
 -   `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
     dynamic linking and OFF for static linking.
 
+-   `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
+    folder.
+
+-   `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
+    you want to link against.
+
 Build the example code by running the following command:
 
 ```bash
 mkdir build
 cd build
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> ..
 cmake --build .
 ```
 
@@ -77,7 +85,9 @@ In case you are using Windows x64, you have to add the option -A in the cmake
 command as follow:
 
 ```bash
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
 ```
 
 **Cross-compilation**.
diff --git a/examples/recording_service/pluggable_storage/c/README.md b/examples/recording_service/pluggable_storage/c/README.md
@@ -58,12 +58,20 @@ In order to build this example, you need to provide the following variables to
 -   `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
     dynamic linking and OFF for static linking.
 
+-   `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
+    folder.
+
+-   `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
+    you want to link against.
+
 Build the example code by running the following command:
 
 ```bash
 mkdir build
 cd build
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> ..
 cmake --build .
 ```
 
@@ -77,7 +85,9 @@ In case you are using Windows x64, you have to add the option -A in the cmake
 command as follow:
 
 ```bash
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
 ```
 
 **Cross-compilation**.
diff --git a/examples/recording_service/service_admin/c++11/README.md b/examples/recording_service/service_admin/c++11/README.md
@@ -47,7 +47,7 @@ Build the example code by running the following command:
 ```sh
 mkdir build
 cd build
-cmake ..
+cmake -DCONNEXTDDS_DIR=<connext dir> -DCONNEXTDDS_ARCH=<connext architecture> ..
 cmake --build .
 ```
 
diff --git a/examples/recording_service/service_as_lib/c++11/README.md b/examples/recording_service/service_as_lib/c++11/README.md
@@ -48,12 +48,20 @@ In order to build this example, you need to provide the following variables to
 -   `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
     dynamic linking and OFF for static linking.
 
+-   `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
+    folder.
+
+-   `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
+    you want to link against.
+
 Build the example code by running the following command:
 
-```sh
+```bash
 mkdir build
 cd build
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> ..
 cmake --build .
 ```
 
@@ -66,8 +74,10 @@ cmake --build .
 In case you are using Windows x64, you have to add the option -A in the cmake
 command as follow:
 
-```sh
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
+```bash
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
+        -DCONNEXTDDS_DIR=<connext dir> \
+        -DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
 ```
 
 This will produce a binary directory (*build*) where the `ServiceAsLibExample`
diff --git a/examples/routing_service/file_adapter/c++11/README.md b/examples/routing_service/file_adapter/c++11/README.md
@@ -66,6 +66,30 @@ supports static linking of adapters. To use this functionality you would need to
 create an application that uses Routing Service as a library component and
 statically links to this `FileAdapter` library.
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ## Running C++ example
 
 To run the example, you just need to run the following command from the `build`
@@ -97,10 +121,10 @@ appropriate value of ```SHAPE_TOPIC``` before starting Routing Service.
 To run Routing Service, you will need first to set up your environment as follows.
 
 Before running the RTI Routing Service, you need to specify where the
-`fileadapter` library is located as shown below:
+`FileAdapterC++11` library is located as shown below:
 
 ```bash
-$export RTI_LD_LIBRARY_PATH=<Connext DDS Directory>/lib/<Connext DDS Architecture>:<Path to fileadapter library>
+$export RTI_LD_LIBRARY_PATH=<Connext DDS Directory>/lib/<Connext DDS Architecture>:<Path to FileAdapterC++11 library>
 ```
 
 ```bash
diff --git a/examples/routing_service/file_adapter/c++11/RsFileAdapter.xml b/examples/routing_service/file_adapter/c++11/RsFileAdapter.xml
@@ -10,8 +10,8 @@
         <adapter_plugin name="FileAdapter">
             <!--
             By specifing this value, RTI Router will search for
-            libfileadapter.so in Unix systems, fileadapter.dll on
-            Windows systems and libfileadapter.dylib on Mac OS. 
+            libFileAdapterC++11.so in Unix systems, FileAdapterC++11.dll on
+            Windows systems and libFileAdapterC++11.dylib on Mac OS. 
             RTI Routing Service will attempt to load this library from:
                 - Working directory or plugin_search_path
                 - Executable directory
diff --git a/examples/routing_service/file_adapter/c/README.md b/examples/routing_service/file_adapter/c/README.md
@@ -43,6 +43,30 @@ supports static linking of adapters. To use this functionality you would need to
 create an application that uses Routing Service as a library component and
 statically links to this `FileAdapter` library.
 
+### Cross-compilation
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+```cmake
+set(CMAKE_SYSTEM_NAME Linux)
+set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+```
+
+Then you can call CMake like this:
+
+```bash
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+```
+
 ## Running C Example
 
 Before running the example, take a look at file_bridge.xml. It defines the
@@ -76,7 +100,7 @@ $export NDDSHOME=<RTI Connext DDS Directory>
 ```
 
 Before running the RTI Routing Service, you also need to specify where the
-`fileadapter` library is located as shown below:
+`FileAdapterC` library is located as shown below:
 
 ```bash
 $export RTI_LD_LIBRARY_PATH=<Path to CMake build folder>
diff --git a/examples/routing_service/file_adapter/c/file_bridge.xml b/examples/routing_service/file_adapter/c/file_bridge.xml
@@ -17,7 +17,7 @@
     <!-- Adapter entry points are defined here -->
     <adapter_library name="adapters">
         <adapter_plugin name="file">
-            <dll>fileadapter</dll>
+            <dll>FileAdapterC</dll>
             <create_function>RTI_RoutingServiceFileAdapterPlugin_create</create_function>
         </adapter_plugin>
     </adapter_library>
diff --git a/examples/routing_service/mongo_db/c++11/README.rst b/examples/routing_service/mongo_db/c++11/README.rst
@@ -50,6 +50,33 @@ Here is more information about generating
     create an application that uses Routing Service as a library component and
     statically link to this adapter.
 
+Cross-compilation
+-----------------
+
+When you need to cross-compile the example, the above
+command will not work, the assigned compiler won't be the cross-compiler and
+errors may happen when linking against the cross-compiled Connext binaries.
+To fix this, you have to create a file with the architecture name and call
+CMake with a specific flag called ``-DCMAKE_TOOLCHAIN_FILE``.
+An example of the file to create with the toolchain settings (e.g. for an
+ARM architectures):
+
+.. code::
+
+    set(CMAKE_SYSTEM_NAME Linux)
+    set(toolchain_path "<path to>/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian")
+    set(CMAKE_C_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-gcc")
+    set(CMAKE_CXX_COMPILER "${toolchain_path}/bin/arm-linux-gnueabihf-g++")
+
+
+Then you can call CMake like this:
+
+.. code::
+
+    cmake -DCONNEXTDDS_DIR=<connext dir> -DCMAKE_TOOLCHAIN_FILE=<toolchain file created above>
+            -DCONNEXTDDS_ARCH=<connext architecture> ..
+
+
 Running
 -------
 
diff --git a/examples/routing_service/monitoring/c++11/README.md b/examples/routing_service/monitoring/c++11/README.md
diff --git a/examples/routing_service/shapes_processor/c++11/README.md b/examples/routing_service/shapes_processor/c++11/README.md
diff --git a/examples/routing_service/struct_array_transf/c++11/README.md b/examples/routing_service/struct_array_transf/c++11/README.md
diff --git a/examples/web_integration_service/library_api/c++11/README.md b/examples/web_integration_service/library_api/c++11/README.md
