Skip to content

Commit

Permalink
Fast DDS v2.8.1 release notes and bump version (#420)
Browse files Browse the repository at this point in the history 
* Refs #16076: Fast DDS v2.8.1 release notes

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16076: Bump Fast DDS docs version to 2.8.1

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16076: fix spelling

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
  • Loading branch information
@JLBuenoLopez
JLBuenoLopez committed Nov 17, 2022
1 parent 0fe3220 commit 92ece65
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 70 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,9 +380,9 @@ def configure_doxyfile(
# built documents.
#
# The short X.Y version.
version = u'2.8.0'
version = u'2.8.1'
# The full version, including alpha/beta/rc tags.
release = u'2.8.0'
release = u'2.8.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
91 changes: 23 additions & 68 deletions docs/notes/notes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,34 @@
Information about the release lifecycle can be found
`here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.

Version 2.8.0
Version 2.8.1
=============

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.

.. 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. :ref:`External locators<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 **bugfixes**:

This release includes the following **improvements**:
1. Statistics module fixes:
1. Increase statistics DataWriter history.
2. Fix Statistics module CI.
3. Install Statistics IDL file.
4. Fix for building in old compilers.
5. Fix core dumped in |DomainParticipant::delete_contained_entities-api|.

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. Address sanitizer fixes:
1. Add ASAN CI job and ``SANITIZE`` :ref:`CMake option <cmake_options>`.
2. Fixes reported by address sanitizer.

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
1. Fix data races when creating DataWriters.
2. Ensure ``shared_mutex`` implementation is consistent throughout supported platforms.

1. Other fixes:
1. Include missing ReadCondition header.
2. Fix selection of output locators.
3. Fix null-dereference on ``parseXMLEnumDynamicType``.
4. Include ``2.8.x`` branch release support.
5. Send GAPs correctly when using separate sending.
6. Fixes for building in old compilers.
7. Fix |DataReader::read_next_instance-api| and |DataReader::take_next_instance-api| implementation.

.. note::
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
Expand All @@ -88,6 +42,7 @@ This release includes the following **bugfixes**:
Previous versions
=================

.. include:: previous_versions/v2.8.0.rst
.. include:: previous_versions/v2.7.1.rst
.. include:: previous_versions/v2.7.0.rst
.. include:: previous_versions/v2.6.2.rst
Expand Down
79 changes: 79 additions & 0 deletions docs/notes/previous_versions/v2.8.0.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Version 2.8.0
^^^^^^^^^^^^^

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.

.. 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. :ref:`External locators<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. 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. 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
files using *fastddsgen*.
If you are upgrading from any older version, regenerating the code is *highly recommended*.

0 comments on commit 92ece65

Please sign in to comment.