Bump version to v2.8.0 (#411)

* Refs #15600: Add v2.7.1 notes page Signed-off-by: Eduardo Ponz <[email protected]> * Refs #15600: Add v2.8.0 release notes Signed-off-by: Eduardo Ponz <[email protected]> * Refs #15600: Bump version to v2.8.0 Signed-off-by: Eduardo Ponz <[email protected]> * Refs #15600: Fix spelling Signed-off-by: Eduardo Ponz <[email protected]> Signed-off-by: Eduardo Ponz <[email protected]>
eProsima · Sep 30, 2022 · f5486de · f5486de
1 parent cd628aa
commit f5486de
Show file tree

Hide file tree

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

diff --git a/docs/fastdds/statistics/dds_layer/domainParticipant.rst b/docs/fastdds/statistics/dds_layer/domainParticipant.rst
@@ -17,6 +17,8 @@ For this purpose, *Fast DDS Statistics module* exposes an extended DDS |Statisti
   :backlinks: none
   :depth: 2
 
+.. _statistics_enable_datawriters:
+
 Enable statistics DataWriters
 -----------------------------
 

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -5,33 +5,80 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-Version 2.7.1
+Version 2.8.0
 =============
 
-This release includes the following **features** in an ABI compatible way:
+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
+fixes.
 
-1. :ref:`check_static_xml_file` by means of |DomainParticipantFactory::check_xml_static_discovery-api|.
-2. :ref:`dds_layer_core_readcondition` implementation.
+.. note::
+    Mind that, even though this release is API compatible with previous v2.x versions, it is *NOT* ABI compatible with
+    previous versions.
+    This means that applications upgrading Fast DDS to v2.8.0 will require recompilation, though not source code
+    modification.
+
+.. note::
+    It is also advisable to regenerate the type support from the IDL files using
+    [Fast DDS-Gen v2.2.0](https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.2.0).
+    Furthermore, if upgrading to v2.8.0, it is also recommended to upgrade Fast CDR to
+    [v1.0.25](https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.25)
+
+This release includes the following **features**:
+
+1. Full :ref:`Ownership<ownershipqospolicy>` and :ref:`OwnershipStrength<ownershipstrengthqospolicy>` QoS support
+2. External locators
+3. UDPv6 support for :ref:`fast-discovery-server tool<cli_discovery>` and
+   :ref:`ROS_DISCOVERY_SERVER<env_vars_ros_discovery_server>`
+4. :ref:`XML configuration support for statistics DataWriters QoS<statistics_enable_datawriters>`
+5. :ref:`SNI support<transport_tcp_tls>`
+6. :ref:`Propagate PropertyQoS properties when explicitly set<propertypolicyqos>`
+7. Add API to createRTPSWriter with a custom pool
+8. Add :class:`std::string::compare` API to :class:`fixed_string`
+9. Get WAN address API in TCPv4 transport descriptors
+10. Adding :class:`DomainParticipantFactory::get_shared_instance()` API
 
 This release includes the following **improvements**:
 
-1. Thread sanitizer CI.
-2. Overload |DataReader::get_unread_count-api|.
-3. Improve read/take performance when using topic with a great number of keys.
-4. Improve rediscovery on lossy environments.
-5. New :ref:`CMake option<cmake_options>` `USE_THIRDPARTY_SHARED_MUTEX`.
-6. Notify changes in bulk in RTPS readers.
+1. Performance improvements:
+    1. Skip writer_removed processing for unaccounted instances
+    2. Improve GUID_t operator< performance
+2. CI improvements:
+    1. Add optional parameters to thread-sanitizer job
+    2. Enable Android testing on device
+3. Examples:
+    1. Update BasicConfigurationExample to allow set up TTL
+    2. Add Guid info to BasicConfiguration Example :class:`cout`
+4. Internal implementation improvements:
+    1. Add script to generate idl files
+    2. Group set_qos_from_attributes free functions into a separate file
+    3. Update script for generating idl files
+    4. Set :class:`last_heartbeat_count_` private member of WriterProxy as atomic
+5. Android Improvements
+6. Upgrade Fast CDR submodule
 
 This release includes the following **bugfixes**:
 
-1. Fix Fast CDR submodule update to v1.0.24.
-2. Fix access to some pointers.
-3. Fixed validation on :class:`ParameterPropertyList_t`.
-4. Fixed acknowledgement in DataSharing.
-5. Fixed wrong usage of :class:`std::remove_if`.
-6. Suppress OpenSSL 3.0 warnings.
-7. Fixed race condition in Logging module.
-8. Other minor fixes and improvements.
+1. Synchronization fixes:
+    1. Fix datarace using writer's locator selectors
+    2. Add lock guard at changing SHM port listener status members
+    3. Add atomic variable to prevent datarace in FlowController
+    4. Disable RTPSParticipantImpl after removing it from RTPSDomain participants list
+    5. Fixing datarace on listener callbacks
+    6. Protect access to reader listeners
+    7. Use thread-safe localtime function in unix distributions
+    8. Fixed usage of uninitialised ifreq
+    9. Adding protection to id_counter access
+2. Repository fixes:
+    1. Fix spelling mistake
+    2. Add python3 dependency to package.xml
+3. Other:
+    1. Fix null dereference on parseXMLBitsetDynamicType
+    2. Change internal include path of nlohmann/json header file
+    3. Instance allocation consistency
+    4. Fix complex member printing for DynamicDataHelper
+    5. Fix initialization order in mock
+    6. Upgraded internal type supports
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -41,6 +88,7 @@ This release includes the following **bugfixes**:
 Previous versions
 =================
 
+.. include:: previous_versions/v2.7.1.rst
 .. include:: previous_versions/v2.7.0.rst
 .. include:: previous_versions/v2.6.2.rst
 .. include:: previous_versions/v2.6.1.rst

diff --git a/docs/notes/previous_versions/v2.7.1.rst b/docs/notes/previous_versions/v2.7.1.rst
@@ -0,0 +1,32 @@
+Version 2.7.1
+^^^^^^^^^^^^^
+
+This release includes the following **features** in an ABI compatible way:
+
+1. :ref:`check_static_xml_file` by means of :cpp:func:`DomainParticipantFactory::check_xml_static_discovery()<eprosima::fastdds::dds::DomainParticipantFactory::check_xml_static_discovery>`.
+2. :ref:`dds_layer_core_readcondition` implementation.
+
+This release includes the following **improvements**:
+
+1. Thread sanitizer CI.
+2. Overload :cpp:func:`get_unread_count()<eprosima::fastdds::dds::DataReader::get_unread_count>`.
+3. Improve read/take performance when using topic with a great number of keys.
+4. Improve rediscovery on lossy environments.
+5. New :ref:`CMake option<cmake_options>` `USE_THIRDPARTY_SHARED_MUTEX`.
+6. Notify changes in bulk in RTPS readers.
+
+This release includes the following **bugfixes**:
+
+1. Fix Fast CDR submodule update to v1.0.24.
+2. Fix access to some pointers.
+3. Fixed validation on :class:`ParameterPropertyList_t`.
+4. Fixed acknowledgement in DataSharing.
+5. Fixed wrong usage of :class:`std::remove_if`.
+6. Suppress OpenSSL 3.0 warnings.
+7. Fixed race condition in Logging module.
+8. 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
@@ -49,12 +49,14 @@ connectionless
 connext
 cout
 coverity
+createRTPSWriter
 crl
 crypto
 cryptographic
 cryptosystem
 datagram
 datagrams
+datarace
 datarate
 datareaders
 deallocate
@@ -103,22 +105,25 @@ HelloWorldTopic
 homebrew
 Homebrew
 hostid
-IDL
 idl
+IDL
 ifaddrs
+ifreq
 ignoreParticipantFlags
 initializations
 interoperability
 intra
 Intra
 IPv
+json
 kB
 keyhash
 latencies
 Libp
 libs
 lifecycle
 localhost
+localtime
 LogTopic
 loopback
 lossy
@@ -144,12 +149,14 @@ namespace
 namespaces
 Namespaces
 nanosec
+nlohmann
 nupkg
 offsetd
 oneway
 OpenSSL
 optionparser
 OSS
+parseXMLBitsetDynamicType
 persistency
 PKI
 pluggable
@@ -219,7 +226,9 @@ uint
 uncheck
 unicast
 unidimensional
+uninitialised
 univocally
+unix
 unmatch
 unmatches
 unmatching