2.3.0 (#255)

* Refs 11028. Move 2.2.0 notes to separate file. Signed-off-by: Miguel Company <[email protected]> * Refs 11028. Notes for 2.3.0 Signed-off-by: Miguel Company <[email protected]> * Refs 11028. Bump to 2.3.0 Signed-off-by: Miguel Company <[email protected]> * Refs 11028: Link documentation sections Signed-off-by: EduPonz <[email protected]> Co-authored-by: EduPonz <[email protected]>
eProsima · Mar 31, 2021 · 415029d · 415029d
1 parent d9732b1
commit 415029d
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 19 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.2.0'
+version = u'2.3.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.2.0'
+release = u'2.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/fastdds/discovery/static.rst b/docs/fastdds/discovery/static.rst
@@ -191,7 +191,7 @@ configured.
 |    :end-before: <!--><-->                                                                                            |
 +----------------------------------------------------------------------------------------------------------------------+
 
-.. _`static_xml_load`:
+.. _static_xml_load:
 
 Loading STATIC EDP XML Files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/fastdds/ros2/discovery_server/ros2_discovery_server.rst b/docs/fastdds/ros2/discovery_server/ros2_discovery_server.rst
@@ -304,6 +304,7 @@ partition from *Talker 2* and so it does not listen to it.
     Once two endpoints know each other, they do not need the server network between them to
     listen to each other messages.
 
+.. _ros2-discovery-server-introspection:
 
 ROS 2 Introspection
 -------------------

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -1,6 +1,6 @@
 .. _release_notes:
 
-Version 2.2.0
+Version 2.3.0
 =============
 
 This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on
@@ -16,36 +16,43 @@ two of the three public APIs:
 
 This release adds the following **features**:
 
-* Data Sharing delivery (avoids transport encapsulation for localhost communications)
-* Complete DDS-PIM high-level API declarations
-* Extension APIs allowing zero-copy delivery (both intra-process and inter-process)
-* Upgrade to Quality Level 1
+* :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**:
 
-* Code coverage policy
-* Added several tests to increase coverage
-* Increased GUID uniqueness
-* Allow logInfo messages to be compiled on build types other than debug
+* 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 timed events manager race condition
-* Fixed payload protection issues with SHM transport
-* Writers correctly handle infinite resource limits on keyed topics
-* Fixed unsafe code on AESGCMGMAC plugin
-* Several fixes for IPv6 (whitelists, address parser)
-* Fixes on liveliness timing handling
-* Fixed warnings building on C++20
+* 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*.
 
+
 Previous versions
 =================
 
+.. include:: previous_versions/v2.2.0.rst
 .. include:: previous_versions/v2.1.0.rst
 .. include:: previous_versions/v2.0.2.rst
 .. include:: previous_versions/v2.0.1.rst

diff --git a/docs/notes/previous_versions/v2.2.0.rst b/docs/notes/previous_versions/v2.2.0.rst
@@ -0,0 +1,43 @@
+Version 2.2.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**:
+
+* Data Sharing delivery (avoids transport encapsulation for localhost communications)
+* Complete DDS-PIM high-level API declarations
+* Extension APIs allowing zero-copy delivery (both intra-process and inter-process)
+* Upgrade to Quality Level 1
+
+It also includes the following **improvements**:
+
+* Code coverage policy
+* Added several tests to increase coverage
+* Increased GUID uniqueness
+* Allow logInfo messages to be compiled on build types other than debug
+
+Some important **bugfixes** are also included:
+
+* Fixed timed events manager race condition
+* Fixed payload protection issues with SHM transport
+* Writers correctly handle infinite resource limits on keyed topics
+* Fixed unsafe code on AESGCMGMAC plugin
+* Several fixes for IPv6 (whitelists, address parser)
+* Fixes on liveliness timing handling
+* Fixed warnings building on C++20
+
+.. 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*.
+