Add Fast DDS v2.9.2 release notes. (#530)

* Refs #19217: add Fast DDS v2.9.2 release notes. Mark as EOL non-supported Fast DDS versions Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #19217: bump version to v2.9.2 Signed-off-by: JLBuenoLopez-eProsima <[email protected]> --------- Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
eProsima · Jul 20, 2023 · f6b22d0 · f6b22d0
1 parent a02d6a0
commit f6b22d0
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 34 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -380,9 +380,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.9.1'
+version = u'2.9.2'
 # The full version, including alpha/beta/rc tags.
-release = u'2.9.1'
+release = u'2.9.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -5,23 +5,66 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-Version 2.9.1
-=============
+Version 2.9.2 (EOL)
+===================
+
+This release includes the following ABI compatible **improvements**:
+
+1. **Library improvements**
+    1. Improve behavior when ``STRICT_REALTIME`` :ref:`CMake option <cmake_options>` is not enabled.
+    2. Using functors for ``for_matched_readers`` parameter.
+    3. Improve auto GAPs in Data Sharing.
+    4. Improve content filter expression parameters check and verbosity.
+    5. Improve validation on ``PID_PROPERTY_LIST`` deserialization.
+2. **Fast DDS CLI**
+    1. Handle ``SIGTERM`` signal.
 
 This release includes the following **bugfixes**:
 
-1. **Synchronization fixes**:
-    1. Fix deadlock in Writer Liveliness Protocol (WLP) using intraprocess.
-    2. Fix data race in
-       :cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`.
-    3. Fix deadlock on TLS closure.
-2. **Other fixes**:
-    1. Fix notification lost.
-    2. Fix ``total_read_`` to be consistent with Reader's History after |DataReader::get_first_untaken_info-api|.
-    3. Use shared pointers for internal singletons.
-    4. Support CCache on Windows.
-    5. Avoid null dereference on fuzzer.
-    6. Other minor fixes and improvements.
+1. Security vulnerability
+    1. Fix chain of trust issues with a single CA certificate.
+2. Library bugfixes
+    1. Fix RTPS StatelessWriter ACK check.
+    2. UBSan (Undefined Behavior Sanitizer) fixes.
+    3. Fix backwards compatibility using SHM communication.
+    4. Correctly handle builtin endpoint mask.
+    5. Fix crash when enabling DisablePositiveACKsQosPolicy with remote best-effort readers.
+    6. Validity check for first sequence number.
+    7. ASAN (Address Sanitizer) fixes.
+    8. Correctly assign multicast port to multicast initial peers.
+    9. Protect against uncaught exception in SHM segment creation.
+    10. Initial acknack backoff.
+    11. Fix crash when calling
+        :cpp:func:`on_requested_deadline_missed() <eprosima::fastdds::dds::DataReaderListener::on_requested_deadline_missed>`
+        callback.
+    12. Security module: Honor ``allow_unauthenticated_participants`` flag.
+    13. Fix crashes caused by not capturing every Fast CDR exception.
+    14. Correctly resolve aliases in DDSSQLFilter.
+    15. Wait for log background thread initialization on the first queued entry.
+    16. Fix partition copy in QoS.
+    17. Fix Data-Sharing delivery when ``data_count`` is zero.
+    18. Fix StatelessWriter locators filtering.
+    19. Avoid double definition of ``FASTDDS_ENFORCE_LOG_INFO``.
+    20. Fixed long-standing reconnection issue on SHM transport.
+3. CI fixes
+    1. Fix test building when using ``GTEST_INDIVIDUAL`` :ref:`CMake <cmake_options>` option.
+    2. Use correct time unit in latency tests.
+4. Synchronization fixes
+    1. Take mutex when removing local reader in WLP.
+    2. Fix data races in SecurityManager authentication process.
+5. Example fixes
+    1. Avoid creating entities within callbacks in DynamicHelloWorldExample.
+    2. Remove Asio dependency from DeadlineQosExample.
+    3. Correct DDS entity deletion order.
+    4. Explicitly register TypeObject in ContentFilteredTopicExample.
+6. Installer generation
+    1. Add documentation fallback when the documentation tag is not found.
+7. Non Tier 1 Support
+    1. Fix build for GCC5.
+    2. Fix build on MSVC 19.36.
+    3. Include right header when building for iOS.
+    4. Forward compatibility with Boost inter-process 1.74+.
+    5. Include missing header files required for compiling with GCC13.
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -31,6 +74,7 @@ This release includes the following **bugfixes**:
 Previous versions
 =================
 
+.. include:: previous_versions/v2.9.1.rst
 .. include:: previous_versions/v2.9.0.rst
 .. include:: previous_versions/v2.8.1.rst
 .. include:: previous_versions/v2.8.0.rst

diff --git a/docs/notes/previous_versions/v2.1.0.rst b/docs/notes/previous_versions/v2.1.0.rst
@@ -1,5 +1,5 @@
-Version 2.1.0
-^^^^^^^^^^^^^
+Version 2.1.0 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on
 two of the three public APIs:

diff --git a/docs/notes/previous_versions/v2.1.1.rst b/docs/notes/previous_versions/v2.1.1.rst
@@ -1,5 +1,5 @@
-Version 2.1.1
-^^^^^^^^^^^^^
+Version 2.1.1 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **bugfixes**:
 

diff --git a/docs/notes/previous_versions/v2.1.2.rst b/docs/notes/previous_versions/v2.1.2.rst
@@ -1,5 +1,5 @@
-Version 2.1.2
-^^^^^^^^^^^^^
+Version 2.1.2 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **improvements**:
 

diff --git a/docs/notes/previous_versions/v2.1.3.rst b/docs/notes/previous_versions/v2.1.3.rst
@@ -1,5 +1,5 @@
-Version 2.1.3
-^^^^^^^^^^^^^
+Version 2.1.3 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **improvements**:
 

diff --git a/docs/notes/previous_versions/v2.7.0.rst b/docs/notes/previous_versions/v2.7.0.rst
@@ -1,5 +1,5 @@
-Version 2.7.0
-^^^^^^^^^^^^^
+Version 2.7.0 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **improvements**:
 

diff --git a/docs/notes/previous_versions/v2.7.1.rst b/docs/notes/previous_versions/v2.7.1.rst
@@ -1,5 +1,5 @@
-Version 2.7.1
-^^^^^^^^^^^^^
+Version 2.7.1 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **features** in an ABI compatible way:
 

diff --git a/docs/notes/previous_versions/v2.8.0.rst b/docs/notes/previous_versions/v2.8.0.rst
@@ -1,5 +1,5 @@
-Version 2.8.0
-^^^^^^^^^^^^^
+Version 2.8.0 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This minor release includes several new features, performance improvements (especially in the case of topics with many
 instances), CI improvements (including the ability to run the CI in Android emulators or devices), and several bug

diff --git a/docs/notes/previous_versions/v2.8.1.rst b/docs/notes/previous_versions/v2.8.1.rst
@@ -1,5 +1,5 @@
-Version 2.8.1
-^^^^^^^^^^^^^
+Version 2.8.1 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **bugfixes**:
 

diff --git a/docs/notes/previous_versions/v2.9.0.rst b/docs/notes/previous_versions/v2.9.0.rst
@@ -1,5 +1,5 @@
-Version 2.9.0
-^^^^^^^^^^^^^
+Version 2.9.0 (EOL)
+^^^^^^^^^^^^^^^^^^^
 
 This minor release includes several new features (new log macros to avoid conflicts with external libraries), behavior
 change (default memory management policy is no longer

diff --git a/docs/notes/previous_versions/v2.9.1.rst b/docs/notes/previous_versions/v2.9.1.rst
@@ -0,0 +1,23 @@
+Version 2.9.1 (EOL)
+^^^^^^^^^^^^^^^^^^^
+
+This release includes the following **bugfixes**:
+
+1. **Synchronization fixes**:
+    1. Fix deadlock in Writer Liveliness Protocol (WLP) using intraprocess.
+    2. Fix data race in
+       :cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`.
+    3. Fix deadlock on TLS closure.
+2. **Other fixes**:
+    1. Fix notification lost.
+    2. Fix ``total_read_`` to be consistent with Reader's History after
+       :cpp:func:`DataReader::get_first_untaken_info()<eprosima::fastdds::dds::DataReader::get_first_untaken_info>`.
+    3. Use shared pointers for internal singletons.
+    4. Support CCache on Windows.
+    5. Avoid null dereference on fuzzer.
+    6. 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
+  files using *fastddsgen*.
+  If you are upgrading from any older version, regenerating the code is *highly recommended*.
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -20,6 +20,7 @@ auth
 autodispose
 autoenable
 autoid
+backoff
 benchmarking
 bitfield
 Bitfields
@@ -91,6 +92,7 @@ fastcdr
 fastdds
 fastddsgen
 foonathan
+functors
 fuzzer
 GCC
 GCM