Skip to content

Commit 970e759

Browse files
cferreiragonzcferreiragonz
authored
Improve windows installation guide (#1175)
* Refs #23985: Delete missleading warning Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com> * Refs #23985: Update Fast DDS Gen Building app in Windows Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com> * Refs #23985: Use Windows references Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com> * Refs #23985: Review - Fix links Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com> --------- Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com>
1 parent c3952ef commit 970e759

4 files changed

Lines changed: 72 additions & 51 deletions

File tree

‎docs/fastddsgen/pubsub_app/includes/dependencies.rst‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,29 +24,39 @@ Colcon installation
2424
^^^^^^^^^^^^^^^^^^^
2525

2626
If the Colcon installation has been followed, there are several ways to import the libraries.
27-
To make these accessible only from the current shell session, run one of the following two commands.
27+
To make these accessible only from the current shell session, run the following command.
2828

29-
* On Linux:
29+
.. tab-set::
3030

31-
.. code-block:: bash
31+
.. tab-item:: Linux
32+
:sync: linux
3233

33-
source <path/to/Fast-DDS/workspace>/install/setup.bash
34+
.. code-block:: bash
3435
35-
* On Windows:
36+
source <path/to/Fast-DDS/workspace>/install/setup.bash
3637
37-
.. code-block:: bash
38+
.. tab-item:: Windows
39+
:sync: windows
40+
41+
.. code-block:: bash
42+
43+
<path/to/Fast-DDS/workspace>/install/setup.bat
3844
39-
<path/to/Fast-DDS/workspace>/install/setup.bat
4045
4146
However, to make these accessible from any session, add the *Fast DDS* installation directory to the ``$PATH``
4247
variable in the shell configuration files running the following command.
4348

44-
* On Linux:
49+
.. tab-set::
50+
51+
.. tab-item:: Linux
52+
:sync: linux
4553

46-
.. code-block:: bash
54+
.. code-block:: bash
4755
48-
echo 'source <path/to/Fast-DDS/workspace>/install/setup.bash' >> ~/.bashrc
56+
echo 'source <path/to/Fast-DDS/workspace>/install/setup.bash' >> ~/.bashrc
4957
50-
* On Windows: Open the `Edit the system environment variables` control panel and add
51-
``<path/to/Fast-DDS/workspace>/install/setup.bat`` to the ``PATH``.
58+
.. tab-item:: Windows
59+
:sync: windows
5260

61+
Open the `Edit the system environment variables` control panel and add
62+
``<path/to/Fast-DDS/workspace>/install/setup.bat`` to the ``PATH``.

‎docs/fastddsgen/pubsub_app/includes/first_app.rst‎

Lines changed: 48 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,43 @@ The ``-example`` option creates an example application, and the CMake files need
1212
In the workspace directory (*FastDDSGenHelloWorld* directory), execute one of the following commands according to the
1313
installation followed and the operating system.
1414

15-
* On Linux:
15+
.. tab-set::
1616

17-
- For an **installation from binaries** or a **colcon installation**:
17+
.. tab-item:: Linux
18+
:sync: linux
1819

19-
.. code:: bash
20+
- For an **installation from binaries** or a **colcon installation**:
2021

21-
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen -example CMake HelloWorld.idl
22+
.. code:: bash
2223
23-
- For a **stand-alone installation**, run:
24+
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen -example CMake HelloWorld.idl
2425
25-
.. code:: bash
26+
- For a **stand-alone installation**, run:
2627

27-
<path-to-Fast-DDS-Gen>/scripts/fastddsgen -example CMake HelloWorld.idl
28+
.. code:: bash
2829
29-
* On Windows:
30+
<path-to-Fast-DDS-Gen>/scripts/fastddsgen -example CMake HelloWorld.idl
3031
31-
- For a **colcon installation**:
32+
.. tab-item:: Windows
33+
:sync: windows
3234

33-
.. code:: winbatch
35+
- For a **colcon installation**:
3436

35-
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen.bat -example CMake HelloWorld.idl
37+
.. code:: winbatch
3638
37-
- For a **stand-alone installation**, run:
39+
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen.bat -example CMake HelloWorld.idl
3840
39-
.. code:: winbatch
41+
- For a **stand-alone installation**, run:
4042

41-
<path-to-Fast-DDS-Gen>/scripts/fastddsgen.bat -example CMake HelloWorld.idl
43+
.. code:: winbatch
4244
43-
- For an **installation from binaries**, run:
45+
<path-to-Fast-DDS-Gen>/scripts/fastddsgen.bat -example CMake HelloWorld.idl
4446
45-
.. code:: winbatch
47+
- For an **installation from binaries**, run:
4648

47-
fastddsgen.bat -example CMake HelloWorld.idl
49+
.. code:: winbatch
50+
51+
fastddsgen.bat -example CMake HelloWorld.idl
4852
4953
.. warning::
5054

@@ -62,40 +66,49 @@ Build the Fast DDS application
6266

6367
Then, compile the generated code executing the following commands from the *FastDDSGenHelloWorld* directory.
6468

65-
* On Linux:
69+
.. tab-set::
70+
71+
.. tab-item:: Linux
72+
:sync: linux
6673

67-
.. code:: bash
74+
.. code:: bash
6875
69-
cd build
70-
cmake ..
71-
make
76+
cd build
77+
cmake ..
78+
make
7279
73-
* On Windows:
80+
.. tab-item:: Windows
81+
:sync: windows
7482

75-
.. code:: bash
83+
.. code-block:: bash
84+
85+
cd build
86+
cmake -G "Visual Studio 16 2019" -A x64 ..
87+
cmake --build .
7688
77-
cd build
78-
cmake -G "Visual Studio 15 2017 Win64" ..
79-
cmake --build .
8089
8190
Run the Fast DDS application
8291
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8392

8493
The application build can be used to spawn any number of publishers and subscribers associated with the topic.
8594

86-
* On Linux:
95+
.. tab-set::
96+
97+
.. tab-item:: Linux
98+
:sync: linux
8799

88-
.. code:: bash
100+
.. code:: bash
89101
90-
./HelloWorld publisher
91-
./HelloWorld subscriber
102+
./HelloWorld publisher
103+
./HelloWorld subscriber
92104
93-
* On Windows:
105+
.. tab-item:: Windows
106+
:sync: windows
94107

95-
.. code:: bash
108+
.. code-block:: bash
96109
97-
HelloWorld.exe publisher
98-
HelloWorld.exe subscriber
110+
HelloWorld.exe publisher
111+
HelloWorld.exe subscriber
99112
100113
101114
Each time <Enter\> is pressed on the Publisher, a new datagram is generated, sent over the network and received by

‎docs/installation/binaries/binaries_windows.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@ version and architecture when prompted.
4949
By default, *eProsima Fast DDS* does not compile tests. To activate them, please refer to the
5050
:ref:`windows_sources` page.
5151

52-
To use the :ref:`cli_xml` validation tool, please refer to the :ref:`windows_sources` page.
53-
5452
.. _contents_bw:
5553

5654
Contents

‎docs/installation/sources/sources_windows.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Windows installation from sources
44
=================================
55

6-
The instructions for installing both the :ref:`Fast DDS library <fastdds_lib_sl>`
7-
and the :ref:`Fast DDS-Gen <fastddsgen_sl>` generation tool from sources are provided in this page.
6+
The instructions for installing both the :ref:`Fast DDS library <fastdds_lib_sw>`
7+
and the :ref:`Fast DDS-Gen <fastddsgen_sw>` generation tool from sources are provided in this page.
88
It is organized as follows:
99

1010
.. _fastdds_lib_sw:

0 commit comments

Comments
 (0)