Skip to content

Commit 922d5b1

Browse files
Mario-DLMario-DL
authored
Add notes for Fast DDS v3.1.0 (#930)
* Refs #21783: Add notes for Fast DDS 3.1.0 Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21783: Apply Jesus review Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
1 parent b167453 commit 922d5b1

File tree

6 files changed

+150
-4
lines changed

6 files changed

+150
-4
lines changed

‎docs/notes/migration_guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
.. include:: ../03-exports/aliases-api.include
33
.. include:: ../03-exports/roles.include
44

5+
.. _migration_guide:
6+
57
Migration Guide to Fast DDS v3
68
==============================
79

‎docs/notes/notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Information about the release lifecycle can be found
66
`here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
77

8-
.. include:: previous_versions/v3.0.1.rst
8+
.. include:: previous_versions/v3.1.0.rst
99

1010
.. seealso::
1111

‎docs/notes/previous_versions/supported_versions.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
Supported versions
22
==================
33

4+
Version 3.1
5+
-----------
6+
7+
.. include:: v3.1.0.rst
8+
49
Version 3.0
5-
------------
10+
-----------
611

12+
.. include:: v3.0.1.rst
713
.. include:: v3.0.0.rst
814

915
Version 2.14

‎docs/notes/previous_versions/v3.0.1.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
`Version 3.0.1 (latest) <https://fast-dds.docs.eprosima.com/en/v3.0.1/index.html>`_
2-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1+
`Version 3.0.1 <https://fast-dds.docs.eprosima.com/en/v3.0.1/index.html>`_
2+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33

44
This patch release includes the following **improvements**:
55

‎docs/notes/previous_versions/v3.1.0.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
`Version 3.1.0 (latest) <https://fast-dds.docs.eprosima.com/en/v3.1.0/index.html>`_
2+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3+
4+
This minor release includes the following **features** in an ABI compatible manner:
5+
6+
#. Allow running CI on external contributions
7+
#. Allow for all durability configurations
8+
#. Complete support for ``Dynamic Network Interfaces``
9+
#. Add :ref:`QoS getters from raw XML <loading_raw_xml_profiles>`
10+
11+
This release includes the following **improvements**:
12+
13+
#. Be less strict with parameter lengths
14+
#. Modify help command of ``XML CLI tool``
15+
#. Register and propagate ``MonitorService`` status type object
16+
#. Add tests for ``TypeLookup service``
17+
#. Convert ``Fast DDS v2`` to ``v3`` Migration Changes into a :ref:`Step-by-Step User Guide <migration_guide>`
18+
#. Update ``asio`` version from ``1.18.1`` to ``1.31.0``
19+
#. Update ``nlohmann/json`` thirdparty version from ``3.9.1`` to ``3.11.3``
20+
#. Regenerate types with latest ``Fast DDS-Gen v4.0.2``
21+
#. Update ``fastcdr`` submodule with latest release
22+
#. Update ``roadmap``, ``release support`` and ``versions`` for ``v3.1.0`` release
23+
24+
This release includes the following **fixes**:
25+
26+
#. Update request reply example ``README``
27+
#. Fix ``xtypes example`` segfault if XML environment var is not set
28+
#. Remove unused ``validMatching`` methods in ``EDP``
29+
#. Add Regression test for ``Fast DDS-Gen`` Use different ``typename`` for collections of ``TK_UINT8`` and ``TK_BYTE``
30+
#. Update latest ``2.10.x`` to ``2.10.5``
31+
#. Discard changes with big ``key-only`` payload and no key hash
32+
#. Add test for support of enumeration literal ``@value`` annotation
33+
#. Fix memory leak deleting ``TypeLookupManager``
34+
#. Fix ``DynamicData`` union deserialization when no member is selected
35+
#. Split nightly jobs to one per workflow
36+
#. Add references to new nightly jobs per supported branch in ``README``
37+
#. Change ``xsd`` files installation directory to ``share/fastdds`` and remove icons on ``windows uninstall``
38+
#. Fix ``flow_controllers`` comparison in ``DomainParticipantQos`` equality operator
39+
#. Fix ``CreateTopicWithDifferentTypeName_negative`` flaky test
40+
#. Warn instead of fail when ``dds.communication.dynamic_interfaces`` cannot be built
41+
#. Fix wrong Data type referred in ``flow control`` example ``README``
42+
43+
.. important::
44+
45+
When upgrading to version 3.1.0 it is **required** to regenerate generated source from IDL files
46+
using at least `Fast DDS-Gen v4.0.2 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.2>`_.
47+
But it is advisable to regenerate them using the latest patch version of ``Fast DDS-Gen v4.0.x``.

‎docs/notes/versions.rst

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,61 @@ The following table shows the minimum version required of the Fast DDS build sys
4949

5050
.. tabs::
5151

52+
.. group-tab:: 3.1.x
53+
54+
.. list-table::
55+
56+
* - **CMake**
57+
- 3.20
58+
59+
.. list-table::
60+
:header-rows: 1
61+
62+
* - OS \ Architecture
63+
- amd64
64+
- amd32
65+
- arm64
66+
* - Ubuntu Noble (24.04)
67+
- Tier 3: GCC 13.2
68+
- **───**
69+
- Tier 3: GCC 13.2
70+
* - Ubuntu Jammy (22.04)
71+
- Tier 1: GCC 11.4 |br|
72+
Tier 3: Clang 15
73+
- **───**
74+
- Tier 1: GCC 11.4 |br|
75+
Tier 3: Clang 15
76+
* - MacOS Mojave (10.14)
77+
- Tier 1: Clang 15
78+
- **───**
79+
- **───**
80+
* - Windows 10
81+
- Tier 1: MSVC v142 (Visual Studio 2019) |br|
82+
Tier 3: MSVC v141 (Visual Studio 2017)
83+
- Tier 3: MSVC v142 (Visual Studio 2019) |br|
84+
Tier 3: MSVC v141 (Visual Studio 2017)
85+
- **───**
86+
* - Windows 11
87+
- Tier 3: MSVC v143 (Visual Studio 2022)
88+
- Tier 3: MSVC v143 (Visual Studio 2022)
89+
- **───**
90+
* - Debian Buster (10)
91+
- Tier 3: GCC 8
92+
- **───**
93+
- Tier 3: GCC 8
94+
* - Android 12
95+
- Tier 3: SDK 31
96+
- **───**
97+
- Tier 3: SDK 31
98+
* - Android 13
99+
- Tier 3: SDK 33
100+
- **───**
101+
- Tier 3: SDK 33
102+
* - QNX 7.1
103+
- Tier 3: QCC (over GCC 8.3)
104+
- **───**
105+
- Tier 3: QCC (over GCC 8.3)
106+
52107
.. group-tab:: 3.0.x
53108

54109
.. list-table::
@@ -258,6 +313,24 @@ The following table shows the corresponding versions of the Fast DDS library dep
258313

259314
.. tabs::
260315

316+
.. group-tab:: 3.1.x
317+
318+
.. list-table::
319+
:header-rows: 1
320+
321+
* - Product
322+
- Related version
323+
* - `Fast CDR <https://github.com/eProsima/Fast-CDR/>`__
324+
- `v2.2.5 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.5>`__
325+
* - `Foonathan Memory Vendor <https://github.com/eProsima/foonathan_memory_vendor/>`__
326+
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`__
327+
* - `Asio <https://github.com/chriskohlhoff/asio>`__
328+
- `v1.31.0 <https://github.com/chriskohlhoff/asio/tree/asio-1-31-0>`__
329+
* - `TinyXML2 <https://github.com/leethomason/tinyxml2>`__
330+
- `v6.0.0 <https://github.com/leethomason/tinyxml2/tree/6.0.0>`__
331+
* - `OpenSSL <https://github.com/openssl/openssl>`__
332+
- `v3.1.1 <https://github.com/openssl/openssl/releases/tag/openssl-3.1.1>`__
333+
261334
.. group-tab:: 3.0.x
262335

263336
.. list-table::
@@ -346,6 +419,24 @@ Fast DDS as the core middleware.
346419

347420
.. tabs::
348421

422+
.. group-tab:: 3.1.x
423+
424+
.. list-table::
425+
:header-rows: 1
426+
427+
* - Product
428+
- Related version
429+
* - `Fast DDS Gen <https://github.com/eProsima/Fast-DDS-Gen/>`__
430+
- `v4.0.2 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.2>`__
431+
* - `Fast DDS Gen - IDL parser <https://github.com/eProsima/IDL-Parser/>`__
432+
- `v4.0.2 <https://github.com/eProsima/IDL-Parser/releases/tag/v4.0.2>`__
433+
* - `Fast DDS python <https://github.com/eProsima/Fast-DDS-python/>`__
434+
- `v2.1.0 <https://github.com/eProsima/Fast-DDS-python/releases/tag/v2.1.0>`__
435+
* - `Shapes Demo <https://github.com/eProsima/ShapesDemo/>`__
436+
- `v3.1.0 <https://github.com/eProsima/ShapesDemo/releases/tag/v3.1.0>`__
437+
* - `Discovery Server <https://github.com/eProsima/Discovery-Server/>`__
438+
- `v2.0.0 <https://github.com/eProsima/Discovery-Server/releases/tag/v2.0.0>`__
439+
349440
.. group-tab:: 3.0.x
350441

351442
.. list-table::

0 commit comments

Comments
 (0)