Skip to content

Commit dcb0272

Browse files
JesusPoderosoJesusPoderoso
authored
Add related versions table (#652)
* Refs #20497: Add related versions table Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Move table to more visible path Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add link Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply internal revision suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Update latest version in ShapesDemo Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add link in installation dependencies sections Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: display Related versions as first 'Versions' page Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add missing header links/references Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Include supported versions in tabs Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Include build time dependencies Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply internal review suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add missing links (gen-related) and fix identation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Refactor build system dependencies table Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add words to spelling whitelist Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply second round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply third round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Please linters Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply fourth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply fifth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply sixth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
1 parent 05ebded commit dcb0272

12 files changed

Lines changed: 478 additions & 3 deletions

File tree

‎docs/02-formalia/titlepage.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,23 @@ Main Features
168168
dependencies (such as *eProsima Fast CDR*) and the external ones (such as the *foonathan* library) are free and
169169
open source.
170170

171+
Dependencies and compatibilities
172+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
173+
174+
*eProsima Fast DDS* is continuously evolving and improving.
175+
This means that the different software products that are part of the Fast DDS ecosystem are evolving and improving
176+
together with Fast DDS.
177+
178+
Fast DDS has some :ref:`library dependencies <dependencies_compatibilities_library_dependencies>`, e.g. the previously
179+
mentioned Fast CDR for data serialization, or OpenSSL for secure communications.
180+
Depending on different :ref:`platform support levels <dependencies_compatibilities_platform_support>`, it has also
181+
different :ref:`build dependencies <dependencies_compatibilities_build_system_dependencies>`.
182+
183+
Finally, there are some other *eProsima* products that use Fast DDS as a middleware, such as *Micro XRCE-DDS*,
184+
*DDS Router* and *Fast DDS python* wrapper.
185+
Those that are strongly attached to each Fast DDS supported version are described in :ref:`this product compatibility
186+
table<dependencies_compatibilities_product_compatibility>`.
187+
171188
Contacts and Commercial support
172189
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
173190

‎docs/fastdds/getting_started/getting_started.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@ application.
1313
definitions
1414
simple_app/simple_app
1515
simple_python_app/simple_python_app
16+
17+
.. seealso::
18+
19+
Check Fast DDS dependencies, libraries, and related packages in the :ref:`dependencies_compatibilities` section.
20+

‎docs/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,9 @@
9393
.. _index_notes:
9494

9595
.. toctree::
96-
:caption: Release Notes
96+
:caption: Versions
9797
:maxdepth: 2
9898
:hidden:
9999

100+
/notes/versions
100101
/notes/notes

‎docs/installation/binaries/binaries_linux.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ The :code:`src` folder contains the following packages:
4848
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
4949
* :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.
5050

51+
.. seealso::
52+
53+
For further information about Fast DDS dependencies, as well as for the corresponding versions of other related
54+
products, please refer to the Fast DDS :ref:`dependencies_compatibilities` section.
55+
5156
In case any of these components is unwanted, it can be simply renamed or removed from the :code:`src`
5257
directory.
5358

‎docs/installation/binaries/binaries_windows.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ By default, the installation will download all the available packages, namely:
7070
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
7171
* :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.
7272

73+
.. seealso::
74+
75+
For further information about Fast DDS dependencies, as well as for the corresponding versions of other related
76+
products, please refer to the Fast DDS :ref:`dependencies_compatibilities` section.
77+
7378
.. _env_vars_bw:
7479

7580
Environment variables

‎docs/installation/sources/sources_linux.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ Dependencies
6969
* :ref:`gtest_sl` [optional]
7070
* :ref:`pythonreq_sl` [optional]
7171

72+
.. seealso::
73+
74+
For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
75+
other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
76+
section.
77+
7278
.. _asiotinyxml2_sl:
7379

7480
Asio and TinyXML2 libraries
@@ -603,6 +609,11 @@ Gradle is an open-source build automation tool which requires a Java version to
603609
*Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
604610
Gradle 8 is not yet supported.
605611

612+
.. seealso::
613+
614+
For further information about Fast DDS-Gen product related versions, please refer to the
615+
:ref:`dependencies_compatibilities_library_dependencies` section.
616+
606617
.. _java_sl:
607618

608619
Java JDK

‎docs/installation/sources/sources_mac.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@ Dependencies
118118
* :ref:`asiotinyxml2_sm`
119119
* :ref:`openssl_sm`
120120

121+
.. seealso::
122+
123+
For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
124+
other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
125+
section.
126+
121127
.. _asiotinyxml2_sm:
122128

123129
Asio and TinyXML2 libraries
@@ -336,6 +342,11 @@ Gradle is an open-source build automation tool which requires a Java version to
336342
*Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
337343
Gradle 8 is not yet supported.
338344

345+
.. seealso::
346+
347+
For further information about Fast DDS-Gen product related versions, please refer to the
348+
:ref:`dependencies_compatibilities_library_dependencies` section.
349+
339350
.. _java_sm:
340351

341352
Java JDK

‎docs/installation/sources/sources_qnx.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ sources. The following packages will be installed:
2626
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
2727
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
2828

29+
.. seealso::
30+
31+
For further information about Fast DDS library dependencies, as well as for the corresponding versions of other
32+
related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies` section.
33+
2934
The :ref:`requirements_sw_qnx` detailed below needs to be met first.
3035

3136
.. _requirements_sw_qnx:
@@ -53,6 +58,11 @@ QNX SDP is QNX's Software Development Platform which contains tools and files wh
5358
For the purpose of these instructions, QNX SDP 7.1 is assumed to be installed at ~/qnx710.
5459
If this is not the case, please adjust the paths accordingly.
5560

61+
.. seealso::
62+
63+
For further information about Fast DDS build system dependencies regarding QNX 7.1, please refer to the Fast DDS
64+
:ref:`dependencies_compatibilities_build_system_dependencies` section.
65+
5666
.. _cmake_pip3_git_sw:
5767

5868
CMake, pip3, git, dos2unix, and automake

‎docs/installation/sources/sources_windows.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@ Dependencies
124124
* :ref:`asiotinyxml2_sw`
125125
* :ref:`openssl_sw`
126126

127+
.. seealso::
128+
129+
For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
130+
other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
131+
section.
132+
127133
.. _asiotinyxml2_sw:
128134

129135
Asio and TinyXML2 libraries
@@ -625,6 +631,11 @@ Gradle is an open-source build automation tool which requires a Java version to
625631
*Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
626632
Gradle 8 is not yet supported.
627633

634+
.. seealso::
635+
636+
For further information about Fast DDS-Gen product related versions, please refer to the
637+
:ref:`dependencies_compatibilities_library_dependencies` section.
638+
628639
.. _java_sb:
629640

630641
Java JDK

‎docs/notes/notes.rst‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,14 @@ This patch release includes the following **fixes**:
2727
9. Set 2.11.x as EOL
2828

2929
.. note::
30-
When upgrading to version 2.13.3 it is **advisable** to regenerate generated source from IDL files
31-
using `Fast DDS-Gen v3.2.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.2.1>`_.
30+
31+
When upgrading to version 2.13.3 it is **advisable** to regenerate generated source from IDL files
32+
using `Fast DDS-Gen v3.2.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.2.1>`_.
33+
34+
.. seealso::
35+
36+
For further information about the corresponding versions of other products related to this Fast DDS version, please
37+
refer to the :ref:`dependencies_compatibilities_product_compatibility` section.
3238

3339
Previous versions
3440
=================

0 commit comments

Comments
 (0)