Add notes for Fast DDS v3.1.0 (#930)

* Refs #21783: Add notes for Fast DDS 3.1.0 Signed-off-by: Mario Dominguez <[email protected]> * Refs #21783: Apply Jesus review Signed-off-by: Mario Dominguez <[email protected]> --------- Signed-off-by: Mario Dominguez <[email protected]>
eProsima · Oct 11, 2024 · 922d5b1 · 922d5b1
1 parent b167453
commit 922d5b1
Show file tree

Hide file tree

Showing 6 changed files with 150 additions and 4 deletions.
diff --git a/docs/notes/migration_guide.rst b/docs/notes/migration_guide.rst
@@ -2,6 +2,8 @@
 .. include:: ../03-exports/aliases-api.include
 .. include:: ../03-exports/roles.include
 
+.. _migration_guide:
+
 Migration Guide to Fast DDS v3
 ==============================
 

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -5,7 +5,7 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-.. include:: previous_versions/v3.0.1.rst
+.. include:: previous_versions/v3.1.0.rst
 
 .. seealso::
 

diff --git a/docs/notes/previous_versions/supported_versions.rst b/docs/notes/previous_versions/supported_versions.rst
@@ -1,9 +1,15 @@
 Supported versions
 ==================
 
+Version 3.1
+-----------
+
+.. include:: v3.1.0.rst
+
 Version 3.0
-------------
+-----------
 
+.. include:: v3.0.1.rst
 .. include:: v3.0.0.rst
 
 Version 2.14

diff --git a/docs/notes/previous_versions/v3.0.1.rst b/docs/notes/previous_versions/v3.0.1.rst
@@ -1,5 +1,5 @@
-`Version 3.0.1 (latest) <https://fast-dds.docs.eprosima.com/en/v3.0.1/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 3.0.1 <https://fast-dds.docs.eprosima.com/en/v3.0.1/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This patch release includes the following **improvements**:
 

diff --git a/docs/notes/previous_versions/v3.1.0.rst b/docs/notes/previous_versions/v3.1.0.rst
@@ -0,0 +1,47 @@
+`Version 3.1.0 (latest) <https://fast-dds.docs.eprosima.com/en/v3.1.0/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This minor release includes the following **features** in an ABI compatible manner:
+
+#. Allow running CI on external contributions
+#. Allow for all durability configurations
+#. Complete support for ``Dynamic Network Interfaces``
+#. Add :ref:`QoS getters from raw XML <loading_raw_xml_profiles>`
+
+This release includes the following **improvements**:
+
+#. Be less strict with parameter lengths
+#. Modify help command of ``XML CLI tool``
+#. Register and propagate ``MonitorService`` status type object
+#. Add tests for ``TypeLookup service``
+#. Convert ``Fast DDS v2`` to ``v3`` Migration Changes into a :ref:`Step-by-Step User Guide <migration_guide>`
+#. Update ``asio`` version from ``1.18.1`` to ``1.31.0``
+#. Update ``nlohmann/json`` thirdparty version from ``3.9.1`` to ``3.11.3``
+#. Regenerate types with latest ``Fast DDS-Gen v4.0.2``
+#. Update ``fastcdr`` submodule with latest release
+#. Update ``roadmap``, ``release support`` and ``versions`` for ``v3.1.0`` release
+
+This release includes the following **fixes**:
+
+#. Update request reply example ``README``
+#. Fix ``xtypes example`` segfault if XML environment var is not set
+#. Remove unused ``validMatching`` methods in ``EDP``
+#. Add Regression test for ``Fast DDS-Gen`` Use different ``typename`` for collections of ``TK_UINT8`` and ``TK_BYTE``
+#. Update latest ``2.10.x`` to ``2.10.5``
+#. Discard changes with big ``key-only`` payload and no key hash
+#. Add test for support of enumeration literal ``@value`` annotation
+#. Fix memory leak deleting ``TypeLookupManager``
+#. Fix ``DynamicData`` union deserialization when no member is selected
+#. Split nightly jobs to one per workflow
+#. Add references to new nightly jobs per supported branch in ``README``
+#. Change ``xsd`` files installation directory to ``share/fastdds`` and remove icons on ``windows uninstall``
+#. Fix ``flow_controllers`` comparison in ``DomainParticipantQos`` equality operator
+#. Fix ``CreateTopicWithDifferentTypeName_negative`` flaky test
+#. Warn instead of fail when ``dds.communication.dynamic_interfaces`` cannot be built
+#. Fix wrong Data type referred in ``flow control`` example ``README``
+
+.. important::
+
+    When upgrading to version 3.1.0 it is **required** to regenerate generated source from IDL files
+    using at least `Fast DDS-Gen v4.0.2 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.2>`_.
+    But it is advisable to regenerate them using the latest patch version of ``Fast DDS-Gen v4.0.x``.
diff --git a/docs/notes/versions.rst b/docs/notes/versions.rst
@@ -49,6 +49,61 @@ The following table shows the minimum version required of the Fast DDS build sys
 
 .. tabs::
 
+    .. group-tab:: 3.1.x
+
+        .. list-table::
+
+            * - **CMake**
+              - 3.20
+
+        .. list-table::
+            :header-rows: 1
+
+            * - OS \ Architecture
+              - amd64
+              - amd32
+              - arm64
+            * - Ubuntu Noble (24.04)
+              - Tier 3: GCC 13.2
+              - **───**
+              - Tier 3: GCC 13.2
+            * - Ubuntu Jammy (22.04)
+              - Tier 1: GCC 11.4 |br|
+                Tier 3: Clang 15
+              - **───**
+              - Tier 1: GCC 11.4 |br|
+                Tier 3: Clang 15
+            * - MacOS Mojave (10.14)
+              - Tier 1: Clang 15
+              - **───**
+              - **───**
+            * - Windows 10
+              - Tier 1: MSVC v142 (Visual Studio 2019) |br|
+                Tier 3: MSVC v141 (Visual Studio 2017)
+              - Tier 3: MSVC v142 (Visual Studio 2019) |br|
+                Tier 3: MSVC v141 (Visual Studio 2017)
+              - **───**
+            * - Windows 11
+              - Tier 3: MSVC v143 (Visual Studio 2022)
+              - Tier 3: MSVC v143 (Visual Studio 2022)
+              - **───**
+            * - Debian Buster (10)
+              - Tier 3: GCC 8
+              - **───**
+              - Tier 3: GCC 8
+            * - Android 12
+              - Tier 3: SDK 31
+              - **───**
+              - Tier 3: SDK 31
+            * - Android 13
+              - Tier 3: SDK 33
+              - **───**
+              - Tier 3: SDK 33
+            * - QNX 7.1
+              - Tier 3: QCC (over GCC 8.3)
+              - **───**
+              - Tier 3: QCC (over GCC 8.3)
+
     .. group-tab:: 3.0.x
 
         .. list-table::
@@ -258,6 +313,24 @@ The following table shows the corresponding versions of the Fast DDS library dep
 
 .. tabs::
 
+    .. group-tab:: 3.1.x
+
+        .. list-table::
+            :header-rows: 1
+
+            * - Product
+              - Related version
+            * - `Fast CDR <https://github.com/eProsima/Fast-CDR/>`__
+              - `v2.2.5 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.5>`__
+            * - `Foonathan Memory Vendor <https://github.com/eProsima/foonathan_memory_vendor/>`__
+              - `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`__
+            * - `Asio <https://github.com/chriskohlhoff/asio>`__
+              - `v1.31.0 <https://github.com/chriskohlhoff/asio/tree/asio-1-31-0>`__
+            * - `TinyXML2 <https://github.com/leethomason/tinyxml2>`__
+              - `v6.0.0 <https://github.com/leethomason/tinyxml2/tree/6.0.0>`__
+            * - `OpenSSL <https://github.com/openssl/openssl>`__
+              - `v3.1.1 <https://github.com/openssl/openssl/releases/tag/openssl-3.1.1>`__
+
     .. group-tab:: 3.0.x
 
         .. list-table::
@@ -346,6 +419,24 @@ Fast DDS as the core middleware.
 
 .. tabs::
 
+    .. group-tab:: 3.1.x
+
+        .. list-table::
+            :header-rows: 1
+
+            * - Product
+              - Related version
+            * - `Fast DDS Gen <https://github.com/eProsima/Fast-DDS-Gen/>`__
+              - `v4.0.2 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.2>`__
+            * - `Fast DDS Gen - IDL parser <https://github.com/eProsima/IDL-Parser/>`__
+              - `v4.0.2 <https://github.com/eProsima/IDL-Parser/releases/tag/v4.0.2>`__
+            * - `Fast DDS python <https://github.com/eProsima/Fast-DDS-python/>`__
+              - `v2.1.0 <https://github.com/eProsima/Fast-DDS-python/releases/tag/v2.1.0>`__
+            * - `Shapes Demo <https://github.com/eProsima/ShapesDemo/>`__
+              - `v3.1.0 <https://github.com/eProsima/ShapesDemo/releases/tag/v3.1.0>`__
+            * - `Discovery Server <https://github.com/eProsima/Discovery-Server/>`__
+              - `v2.0.0 <https://github.com/eProsima/Discovery-Server/releases/tag/v2.0.0>`__
+
     .. group-tab:: 3.0.x
 
         .. list-table::