Skip to content

Commit d618c12

Browse files
Improve documentation in Recording examples so the CMake command always works
1 parent 8341c83 commit d618c12

File tree

4 files changed

+39
-9
lines changed

4 files changed

+39
-9
lines changed

examples/recording_service/pluggable_storage/c++11/README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,20 @@ In order to build this example, you need to provide the following variables to
5858
- `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
5959
dynamic linking and OFF for static linking.
6060

61+
- `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
62+
folder.
63+
64+
- `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
65+
you want to link against.
66+
6167
Build the example code by running the following command:
6268

6369
```bash
6470
mkdir build
6571
cd build
66-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
72+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
73+
-DCONNEXTDDS_DIR=<connext dir> \
74+
-DCONNEXTDDS_ARCH=<connext architecture> ..
6775
cmake --build .
6876
```
6977

@@ -77,7 +85,9 @@ In case you are using Windows x64, you have to add the option -A in the cmake
7785
command as follow:
7886

7987
```bash
80-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
88+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
89+
-DCONNEXTDDS_DIR=<connext dir> \
90+
-DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
8191
```
8292

8393
**Cross-compilation**.

examples/recording_service/pluggable_storage/c/README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,20 @@ In order to build this example, you need to provide the following variables to
5858
- `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
5959
dynamic linking and OFF for static linking.
6060

61+
- `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
62+
folder.
63+
64+
- `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
65+
you want to link against.
66+
6167
Build the example code by running the following command:
6268

6369
```bash
6470
mkdir build
6571
cd build
66-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
72+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
73+
-DCONNEXTDDS_DIR=<connext dir> \
74+
-DCONNEXTDDS_ARCH=<connext architecture> ..
6775
cmake --build .
6876
```
6977

@@ -77,7 +85,9 @@ In case you are using Windows x64, you have to add the option -A in the cmake
7785
command as follow:
7886

7987
```bash
80-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
88+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
89+
-DCONNEXTDDS_DIR=<connext dir> \
90+
-DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
8191
```
8292

8393
**Cross-compilation**.

examples/recording_service/service_admin/c++11/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Build the example code by running the following command:
4747
```sh
4848
mkdir build
4949
cd build
50-
cmake ..
50+
cmake -DCONNEXTDDS_DIR=<connext dir> -DCONNEXTDDS_ARCH=<connext architecture> ..
5151
cmake --build .
5252
```
5353

examples/recording_service/service_as_lib/c++11/README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,20 @@ In order to build this example, you need to provide the following variables to
4848
- `BUILD_SHARED_LIBS`: specifies the link mode. Valid values are ON for
4949
dynamic linking and OFF for static linking.
5050

51+
- `CONNEXTDDS_DIR`: specifies the path to your RTI Connext installation
52+
folder.
53+
54+
- `CONNEXTDDS_ARCH`: specifies the architecture of the specific libraries
55+
you want to link against.
56+
5157
Build the example code by running the following command:
5258

53-
```sh
59+
```bash
5460
mkdir build
5561
cd build
56-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
62+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
63+
-DCONNEXTDDS_DIR=<connext dir> \
64+
-DCONNEXTDDS_ARCH=<connext architecture> ..
5765
cmake --build .
5866
```
5967

@@ -66,8 +74,10 @@ cmake --build .
6674
In case you are using Windows x64, you have to add the option -A in the cmake
6775
command as follow:
6876

69-
```sh
70-
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. -A x64
77+
```bash
78+
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON \
79+
-DCONNEXTDDS_DIR=<connext dir> \
80+
-DCONNEXTDDS_ARCH=<connext architecture> .. -A x64
7181
```
7282

7383
This will produce a binary directory (*build*) where the `ServiceAsLibExample`

0 commit comments

Comments
 (0)