Release notes Fast DDS v2.1.2 (#388)

* Refs #15163: release notes Fast DDS v2.1.2 Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15163: apply review suggestions Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15163: fix spelling Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
eProsima · Jul 26, 2022 · f5e11d4 · f5e11d4
1 parent 09b4277
commit f5e11d4
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 54 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -287,9 +287,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.1.1'
+version = u'2.1.2'
 # The full version, including alpha/beta/rc tags.
-release = u'2.1.1'
+release = u'2.1.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
@@ -1,67 +1,42 @@
 .. _release_notes:
 
-Version 2.1.0
+Version 2.1.2
 =============
 
-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.
-
-Users of the RTPS low-level API should also be aware of the following **API deprecations**:
-
-* History::reserve_Cache has been deprecated
-
-  * Methods RTPSWriter::new_change or RTPSReader::reserveCache should be used instead
-
-* History::release_Cache has been deprecated
-
-  * Methods RTPSWriter::release_change or RTPSReader::releaseCache should be used instead
-
-This release adds the following **features**:
-
-* Support persistence for large data
-* Added support for `on_requested_incompatible_qos` and `on_offered_incompatible_qos`
-* SKIP_DEFAULT_XML environment variable
-* Added FORCE value to THIRDPARTY cmake options
-* New log consumer (StdOutErrConsumer)
-* Added methods to get qos defined in XML Profile
-* Support for persistence on TRANSIENT_LOCAL
-
-It also includes the following **improvements**:
-
-* Internal refactor for intra-process performance boost
-* Allow usage of foonathan/memory library built without debug tool
-* Large data support on performance tests
-* Reduced flakiness of several tests
-
-Some important **bugfixes** are also included:
-
-* Fixed behavior of several DDS API methods
-* Fixed interoperability issues with RTI connext
-* Fixed DLL export of some methods
-* Avoid redefinition of compiler defined macros
-* Fixed some intra-process related segmentation faults and deadlocks
-* Fixed large data payload protection issues on intra-process
-* Fixed C++17 and VS 2019 warnings
-* Fixed linker problems on some platforms
-* Fixed transient local retransmission after participant drop
-* Fixed assertion failure on persistent writers
+This release includes the following **improvements**:
+
+1. Allow fully qualified name in TypeDescriptor.
+1. Use native inter-process on Windows.
+1. Support for GCC 12.
+1. Support of googletest using colcon.
+
+This release also includes the following **bugfixes**:
+
+1. Fixed recovery of shared memory buffers.
+1. Fixed issues in LivelinessManager.
+1. Fixed default multicast locators.
+1. Fixed TCP issues.
+1. Fixed deadlocks and data races.
+1. Fixed deadline issue on volatile DataWriter.
+1. Avoid bad_node_size exception when cross-building.
+1. Fixed order of returned samples on topics with keys.
+1. Allow updating partitions to an empty set.
+1. Suppress OpenSSL 3.0 warnings.
+1. MemberDescriptor fully qualified name.
+1. Fixed history record issues with persistence.
+1. Fixed reconnection to Discovery Server.
+1. Other minor fixes.
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
-  files using *fastrtpsgen*.
+  files using *fastddsgen*.
   If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
 
 Previous versions
 =================
 
+.. include:: previous_versions/v2.1.1.rst
+.. include:: previous_versions/v2.1.0.rst
 .. include:: previous_versions/v2.0.2.rst
 .. include:: previous_versions/v2.0.1.rst
 .. include:: previous_versions/v2.0.0.rst

diff --git a/docs/notes/previous_versions/v2.1.0.rst b/docs/notes/previous_versions/v2.1.0.rst
@@ -0,0 +1,58 @@
+Version 2.1.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.
+
+Users of the RTPS low-level API should also be aware of the following **API deprecations**:
+
+* History::reserve_Cache has been deprecated
+
+  * Methods RTPSWriter::new_change or RTPSReader::reserveCache should be used instead
+
+* History::release_Cache has been deprecated
+
+  * Methods RTPSWriter::release_change or RTPSReader::releaseCache should be used instead
+
+This release adds the following **features**:
+
+* Support persistence for large data
+* Added support for `on_requested_incompatible_qos` and `on_offered_incompatible_qos`
+* SKIP_DEFAULT_XML environment variable
+* Added FORCE value to THIRDPARTY cmake options
+* New log consumer (StdOutErrConsumer)
+* Added methods to get qos defined in XML Profile
+* Support for persistence on TRANSIENT_LOCAL
+
+It also includes the following **improvements**:
+
+* Internal refactor for intra-process performance boost
+* Allow usage of foonathan/memory library built without debug tool
+* Large data support on performance tests
+* Reduced flakiness of several tests
+
+Some important **bugfixes** are also included:
+
+* Fixed behavior of several DDS API methods
+* Fixed interoperability issues with RTI connext
+* Fixed DLL export of some methods
+* Avoid redefinition of compiler defined macros
+* Fixed some intra-process related segmentation faults and deadlocks
+* Fixed large data payload protection issues on intra-process
+* Fixed C++17 and VS 2019 warnings
+* Fixed linker problems on some platforms
+* Fixed transient local retransmission after participant drop
+* Fixed assertion failure on persistent writers
+
+.. note::
+  If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
+  files using *fastrtpsgen*.
+  If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
diff --git a/docs/notes/previous_versions/v2.1.1.rst b/docs/notes/previous_versions/v2.1.1.rst
@@ -0,0 +1,20 @@
+Version 2.1.1
+^^^^^^^^^^^^^
+
+This release includes the following bugfixes:
+
+* Fixed race condition on security handshake
+* Fixed SHM data corruption when using both payload and sub-message protection
+* Fixed some interoperability issues
+* Fixed race condition on timed-events thread
+* Fixed usage of SHM on QNX systems
+
+It also includes the following improvements:
+
+* Increased uniqueness of GUID prefix
+* Discovery server 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 a version older than 1.10.0, regenerating the code is *recommended*.
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -28,6 +28,7 @@ bitset
 bitsets
 boolean
 booleans
+bugfixes
 Cannonical
 CDR
 centric
@@ -82,6 +83,7 @@ getter
 Github
 GMAC
 GMock
+googletest
 gradle
 gtest
 GTest
@@ -140,6 +142,7 @@ QosPolicyCount
 quadratically
 readNextData
 reconfigurations
+reconnection
 redistributable
 replier
 repos