Fast DDS v2.5.1 (#346)

* Refs #13962: add Fast DDS v2.5.1 release notes

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #13962: fix numbering (review suggestion)

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs 13962: Bump version to v2.5.1

Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com>

Co-authored-by: Eduardo Ponz <eduardoponz@eprosima.com>

README.md

@@ -116,8 +116,8 @@ building tools.
     ```bash
     mkdir -p <path_to_ws>/fastdds-docs_ws/src
     cd <path_to_ws>/fastdds-docs_ws
-    wget https://raw.githubusercontent.com/eProsima/Fast-DDS-docs/master/colcon.meta
-    wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos
+    wget https://raw.githubusercontent.com/eProsima/Fast-DDS-docs/<version>/colcon.meta
+    wget https://raw.githubusercontent.com/eProsima/Fast-DDS/<version>/fastrtps.repos
     vcs import src < fastrtps.repos
     cd src
     git clone https://github.com/eProsima/Fast-DDS-docs fastdds-docs

docs/conf.py

@@ -372,9 +372,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.5.0'
+version = u'2.5.1'
 # The full version, including alpha/beta/rc tags.
-release = u'2.5.0'
+release = u'2.5.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/notes/notes.rst

@@ -3,50 +3,34 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-Version 2.5.0
+Version 2.5.1
 =============
 
-This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on
-two of the three public APIs:
+This release includes the following **improvements**:
 
-* Methods and attributes have been added on several classes of the DDS-PIM high-level API, so indexes of
-  symbols on dynamic libraries may have changed.
+1. ContentFilterTopic filtering at the DataReader side.
+2. Release lifecycle.
 
-* Methods and attributes have been added on several classes of the RTPS low-level API, so indexes of
-  symbols on dynamic libraries may have changed.
+This release includes the following **bugfixes**:
 
-* Old Fast-RTPS high-level API remains ABI compatible.
-
-This minor release includes the following **features**:
-
-1. :ref:`Support for PKCS#11 <pkcs11-support>` format URIs for private keys
-2. Added interfaces for content filter APIs
-3. Allow new :ref:`network interfaces to be detected at runtime <dynamic-network-interfaces>`
-4. New API on :ref:`DataWriter <api_pim_datawriter>` to wait for a specific instance to be acknowledged
-5. Added interfaces for :ref:`concatenation of transports <transport_transportApi_chaining>`
-6. Allow :ref:`XML profiles to be loaded from a string <loadingapplyingprofiles>`
-7. Allow :ref:`disabling piggyback heartbeat <xml_disableheartbeatpiggyback>` on XML and DataWriter QoS
-8. New basic configuration example
-
-It also includes the following **improvements**:
-
-1. Working implementation of instance_state and view_state
-2. Allow zero-valued keys
-3. Made some type aliases public to ease python bindings integration
-4. Improved performance by avoiding unnecessary payload copies for samples that are going to be rejected
-5. Removed unnecessary headers from Log module public headers
-6. Add support for Key annotation in TypeObjectFactory
-7. Only export public symbols on non-windows platforms
-8. Some documentation improvements
-
-Some important **bugfixes** are also included:
-
-1. Fixed payload pool handling on EDPSimple destructor
-2. Fixed null dereference on XML parser
-3. Correctly export XTypes related methods on Windows
-4. Ensure correct boost singleton destruction order
-5. Avoid warning when environment file filename is empty
-6. Correctly set GUID of DataWriter and DataReader upon creation
+1. XML parser fixes.
+2. Discovery Server fixes.
+3. Fix DataSharing sample validation.
+4. PKCS#11 support fixes.
+5. Test fixes.
+6. Doxygen documentation fixes.
+7. GAP message fix.
+8. Enable memory protection on DataSharing readers.
+9. TCP reconnection issues.
+10. Fix dynamic network interfaces feature.
+11. Several Security module fixes.
+12. STRICT_REALTIME fix.
+13. Suppress OpenSSL 3.0 warnings.
+14. Move optionparser to thirdparty.
+15. Thread-safe access to endpoints collections.
+16. MemberDescriptor fully qualified name.
+17. Setting QoS fix.
+18. Other minor fixes and improvements.
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -56,6 +40,7 @@ Some important **bugfixes** are also included:
 Previous versions
 =================
 
+.. include:: previous_versions/v2.5.0.rst
 .. include:: previous_versions/v2.4.1.rst
 .. include:: previous_versions/v2.4.0.rst
 .. include:: previous_versions/v2.3.4.rst

docs/notes/previous_versions/v2.5.0.rst

@@ -0,0 +1,49 @@
+Version 2.5.0
+^^^^^^^^^^^^^
+
+This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on
+two of the three public APIs:
+
+* Methods and attributes have been added on several classes of the DDS-PIM high-level API, so indexes of
+  symbols on dynamic libraries may have changed.
+
+* Methods and attributes have been added on several classes of the RTPS low-level API, so indexes of
+  symbols on dynamic libraries may have changed.
+
+* Old Fast-RTPS high-level API remains ABI compatible.
+
+This minor release includes the following **features**:
+
+1. :ref:`Support for PKCS#11 <pkcs11-support>` format URIs for private keys
+2. Added interfaces for content filter APIs
+3. Allow new :ref:`network interfaces to be detected at runtime <dynamic-network-interfaces>`
+4. New API on :ref:`DataWriter <api_pim_datawriter>` to wait for a specific instance to be acknowledged
+5. Added interfaces for :ref:`concatenation of transports <transport_transportApi_chaining>`
+6. Allow :ref:`XML profiles to be loaded from a string <loadingapplyingprofiles>`
+7. Allow :ref:`disabling piggyback heartbeat <xml_disableheartbeatpiggyback>` on XML and DataWriter QoS
+8. New basic configuration example
+
+It also includes the following **improvements**:
+
+1. Working implementation of instance_state and view_state
+2. Allow zero-valued keys
+3. Made some type aliases public to ease python bindings integration
+4. Improved performance by avoiding unnecessary payload copies for samples that are going to be rejected
+5. Removed unnecessary headers from Log module public headers
+6. Add support for Key annotation in TypeObjectFactory
+7. Only export public symbols on non-windows platforms
+8. Some documentation improvements
+
+Some important **bugfixes** are also included:
+
+1. Fixed payload pool handling on EDPSimple destructor
+2. Fixed null dereference on XML parser
+3. Correctly export XTypes related methods on Windows
+4. Ensure correct boost singleton destruction order
+5. Avoid warning when environment file filename is empty
+6. Correctly set GUID of DataWriter and DataReader upon creation
+
+.. note::
+  If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
+  files using *fastddsgen*.
+  If you are upgrading from any older version, regenerating the code is *highly recommended*.

docs/spelling_wordlist.txt

@@ -141,6 +141,7 @@ nanosec
 nupkg
 offsetd
 oneway
+optionparser
 OSS
 persistency
 PKI
@@ -194,6 +195,7 @@ superset
 takeNextData
 TCP
 tcpdump
+thirdparty
 tinyxml
 topologies
 Topologies