2.3.1 (#263)

* Refs 11275. Move 2.3.0 notes to other file. Signed-off-by: Miguel Company <[email protected]> * Refs 11275. Notes for 2.3.1. Signed-off-by: Miguel Company <[email protected]> * Refs 11275. Bump to 2.3.1 Signed-off-by: Miguel Company <[email protected]> * Refs 11275. Apply suggestion. Signed-off-by: Miguel Company <[email protected]> Co-authored-by: Eduardo Ponz Segrelles <[email protected]> Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
eProsima · Apr 28, 2021 · 4e3cd1f · 4e3cd1f
1 parent 346fbdf
commit 4e3cd1f
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 42 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -293,9 +293,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.3.0'
+version = u'2.3.1'
 # The full version, including alpha/beta/rc tags.
-release = u'2.3.0'
+release = u'2.3.1'
 
 # 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,57 +1,30 @@
 .. _release_notes:
 
-Version 2.3.0
+Version 2.3.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 several **bugfixes** and **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.
-
-* 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 release adds the following **features**:
-
-* :ref:`Unique network flows <use-case-unique-flows>`
-* :ref:`Discovery super-client <ros2-discovery-server-introspection>`
-* :ref:`Statistics module API <statistics>`
-* :ref:`New flow controller API <api_pim_publishmodeqospolicy>`
-* :ref:`Static discovery configuration from raw string <static_xml_load>`
-* :ref:`Added reception timestamp to SampleInfo <api_pim_sampleinfo>`
-* :ref:`Exposing get_unread_count on DataReader <api_pim_datareader>`
-
-It also includes the following **improvements**:
-
-* Data-sharing delivery internal refactor
-* Additional metadata on persistence databases
-* Refactor on ReturnCode_t to make it switch friendly
-* Performance tests refactored to use DDS-PIM high-level API
-* Receive const pointers on delete_xxx methods
-* Discovery server improvements
-* Made SOVERSION follow major.minor
-
-Some important **bugfixes** are also included:
-
-* Fixed shared memory usage on QNX
-* Fixed reference counting on internal pools
-* Fixed singleton destruction order
-* Fixed interoperability issues with x-types information
-* Fixed recovery of shared memory buffers
-* Lifespan support in persistent writers
+* Added :ref:`Fast DDS Statistics Module <statistics>` implementation
+* Fixed alignment issues on generated code calculation of maximum serialized size
+* Fixed calculation of data-sharing domain id
+* Fixed issues on data-sharing with volatile writers
+* Fixed build issues on old compilers
+* Fixed some tests when the library is built without security
+* Fixed and exposed pull mode on writers
+* Fixed handling of `--data_sharing` on latency test
+* Fixed calculation of memory pools sizes on debug builds
+* Correctly update memory policy on writers and readers
 
 .. 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*.
 
-
 Previous versions
 =================
 
+.. include:: previous_versions/v2.3.0.rst
 .. include:: previous_versions/v2.2.0.rst
 .. include:: previous_versions/v2.1.0.rst
 .. include:: previous_versions/v2.0.2.rst

diff --git a/docs/notes/previous_versions/v2.3.0.rst b/docs/notes/previous_versions/v2.3.0.rst
@@ -0,0 +1,48 @@
+Version 2.3.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 release adds the following **features**:
+
+* :ref:`Unique network flows <use-case-unique-flows>`
+* :ref:`Discovery super-client <ros2-discovery-server-introspection>`
+* :ref:`Statistics module API <statistics>`
+* :ref:`New flow controller API <api_pim_publishmodeqospolicy>`
+* :ref:`Static discovery configuration from raw string <static_xml_load>`
+* :ref:`Added reception timestamp to SampleInfo <api_pim_sampleinfo>`
+* :ref:`Exposing get_unread_count on DataReader <api_pim_datareader>`
+
+It also includes the following **improvements**:
+
+* Data-sharing delivery internal refactor
+* Additional metadata on persistence databases
+* Refactor on ReturnCode_t to make it switch friendly
+* Performance tests refactored to use DDS-PIM high-level API
+* Receive const pointers on delete_xxx methods
+* Discovery server improvements
+* Made SOVERSION follow major.minor
+
+Some important **bugfixes** are also included:
+
+* Fixed shared memory usage on QNX
+* Fixed reference counting on internal pools
+* Fixed singleton destruction order
+* Fixed interoperability issues with x-types information
+* Fixed recovery of shared memory buffers
+* Lifespan support in 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 *fastddsgen*.
+  If you are upgrading from any older version, regenerating the code is *highly recommended*.
+