Skip to content

Commit

Permalink
Bump to 2.10.1 and updated release notes (#476)
Browse files Browse the repository at this point in the history 
* Refs #17983: Bump to 2.10.1 and updated release notes

Signed-off-by: Javier Santiago <[email protected]>

* Refs #17983: Fixed notes and spelling

Signed-off-by: Javier Santiago <[email protected]>

---------

Signed-off-by: Javier Santiago <[email protected]>
  • Loading branch information
@jsan-rt
jsan-rt authored Apr 4, 2023
1 parent d39968d commit 4923617
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 77 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.10.0'
version = u'2.10.1'
# The full version, including alpha/beta/rc tags.
release = u'2.10.0'
release = u'2.10.1'

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

Version 2.10.0
Version 2.10.1
==============

This minor release includes several new features, improvements and bugfixes.
This release includes the following **feature** in an ABI compatible way:

.. 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.10.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.4.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.4.0>`_.
Furthermore, if upgrading to v2.10.0, it is also recommended to upgrade Fast CDR to
`v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_.

This release includes the following **features**:

1. New :ref:`dds_layer_publisher_dataWriterListener_on_unack_sample_removed` in
:cpp:class:`DataWriterListener <eprosima::fastdds::dds::DataWriterListener>`.
2. :ref:`Secure Discovery Server <DS_security>`.
3. DomainParticipant ignore empty API.
4. RTPS :cpp:func:`ReaderListener::on_incompatible_type <eprosima::fastrtps::rtps::ReaderListener::on_incompatible_type>`
and :cpp:func:`WriterListener::on_incompatible_type <eprosima::fastrtps::rtps::WriterListener::on_incompatible_type>`
empty API.
1. :cpp:func:`ignore_participant()<eprosima::fastdds::dds::DomainParticipant::ignore_participant>` implementation

This release includes the following **improvements**:
This release includes the following **bugfixes**:

1. **Fast DDS improvements**
1. Improve behavior when ``STRICT_REALTIME`` :ref:`CMake option <cmake_options>` is not enabled.
2. Using functors for ``for_matched_readers`` parameter.
3. Improve auto GAPs in Data Sharing.
4. Use standard value for ``PID_RELATED_SAMPLE_IDENTITY``.
2. **Contributions and repository quality**
1. Update Pull Request template.
2. Update foonathan_memory quality declaration.
3. Update XSD schema.
4. Make network headers private avoiding exposing non-public API.
5. Improve Doxygen documentation for
:cpp:class:`ResourceLimitsQosPolicy <eprosima::fastdds::dds::ResourceLimitsQosPolicy>`.
3. **Examples**
1. New :ref:`Request-Reply example <use-case-request-reply>`.
4. **CI improvements**
1. New workflow to check documentation build.
2. ASAN workflow updated to use Ubuntu 22.04.
5. **Dependencies**
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.4.0.
2. Upgrade Fast CDR submodule to v1.0.27.
6. **Fast DDS CLI**
1. Handle ``SIGTERM`` signal.
7. **Community supported platforms**
1. :ref:`QNX 7.1 build infrastructure <qnx_sources>`.
1. Fix repeated matched event notification.
2. Fix regression introduced by #3396.
3. Initial acknack backoff.
4. Fix regular expression in XML schema.
5. Correctly assign multicast port to multicast initial peers.

This release includes the following **fixes**:
This release includes the following **CI improvements**:

1. **Security vulnerability**
1. Fix chain of trust issues with a single CA certificate.
2. **Bugfixes**
1. Fix RTPS StatelessWriter ACK check.
2. ASAN (Address Sanitizer) fixes.
3. UBSan (Undefined Behavior Sanitizer) fixes.
4. Export public API correctly in Windows.
5. Correctly handle builtin endpoints mask.
6. Fix backwards compatibility using SHM communication.
7. Protect against uncaught exception in SHM segment creation.
8. Fix build for GCC 5.
9. Validity check for first sequence number.
10. Fix crash when enabling DisablePositiveACKsQoSPolicy with remote best-effort readers.
3. **Synchronization fixes**
1. Take mutex when removing local reader in WLP.
2. Fix data races in SecurityManager authentication process.
4. **CI fixes**
1. Fix test building when using ``GTEST_INDIVIDUAL`` :ref:`CMake option <cmake_options>`.
2. Fix overflow in received samples in performance tests.
5. **Example fixes**
1. Avoid creating entities within callbacks in DynamicHelloWorldExample.
2. Remove Asio dependency from DeadlineQoSExample.
6. **Repository fixes**
1. Remove 2.7.x as active branch.
7. **Community supported platforms**
1. Include right header when building for iOS.
1. Update runner and GCC version for Thread Sanitizer job.

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

.. include:: previous_versions/v2.10.0.rst
.. include:: previous_versions/v2.9.1.rst
.. include:: previous_versions/v2.9.0.rst
.. include:: previous_versions/v2.8.1.rst
Expand Down
87 changes: 87 additions & 0 deletions docs/notes/previous_versions/v2.10.0.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
Version 2.10.0
^^^^^^^^^^^^^^

This minor release includes several new features, improvements and bugfixes.

.. 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.10.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.4.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.4.0>`_.
Furthermore, if upgrading to v2.10.0, it is also recommended to upgrade Fast CDR to
`v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_.

This release includes the following **features**:

1. New :ref:`dds_layer_publisher_dataWriterListener_on_unack_sample_removed` in
:cpp:class:`DataWriterListener <eprosima::fastdds::dds::DataWriterListener>`.
2. :ref:`Secure Discovery Server <DS_security>`.
3. DomainParticipant ignore empty API.
4. RTPS :cpp:func:`ReaderListener::on_incompatible_type <eprosima::fastrtps::rtps::ReaderListener::on_incompatible_type>`
and :cpp:func:`WriterListener::on_incompatible_type <eprosima::fastrtps::rtps::WriterListener::on_incompatible_type>`
empty API.

This release includes the following **improvements**:

1. **Fast DDS improvements**
1. Improve behavior when ``STRICT_REALTIME`` :ref:`CMake option <cmake_options>` is not enabled.
2. Using functors for ``for_matched_readers`` parameter.
3. Improve auto GAPs in Data Sharing.
4. Use standard value for ``PID_RELATED_SAMPLE_IDENTITY``.
2. **Contributions and repository quality**
1. Update Pull Request template.
2. Update foonathan_memory quality declaration.
3. Update XSD schema.
4. Make network headers private avoiding exposing non-public API.
5. Improve Doxygen documentation for
:cpp:class:`ResourceLimitsQosPolicy <eprosima::fastdds::dds::ResourceLimitsQosPolicy>`.
3. **Examples**
1. New :ref:`Request-Reply example <use-case-request-reply>`.
4. **CI improvements**
1. New workflow to check documentation build.
2. ASAN workflow updated to use Ubuntu 22.04.
5. **Dependencies**
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.4.0.
2. Upgrade Fast CDR submodule to v1.0.27.
6. **Fast DDS CLI**
1. Handle ``SIGTERM`` signal.
7. **Community supported platforms**
1. :ref:`QNX 7.1 build infrastructure <qnx_sources>`.

This release includes the following **fixes**:

1. **Security vulnerability**
1. Fix chain of trust issues with a single CA certificate.
2. **Bugfixes**
1. Fix RTPS StatelessWriter ACK check.
2. ASAN (Address Sanitizer) fixes.
3. UBSan (Undefined Behavior Sanitizer) fixes.
4. Export public API correctly in Windows.
5. Correctly handle builtin endpoints mask.
6. Fix backwards compatibility using SHM communication.
7. Protect against uncaught exception in SHM segment creation.
8. Fix build for GCC 5.
9. Validity check for first sequence number.
10. Fix crash when enabling DisablePositiveACKsQoSPolicy with remote best-effort readers.
3. **Synchronization fixes**
1. Take mutex when removing local reader in WLP.
2. Fix data races in SecurityManager authentication process.
4. **CI fixes**
1. Fix test building when using ``GTEST_INDIVIDUAL`` :ref:`CMake option <cmake_options>`.
2. Fix overflow in received samples in performance tests.
5. **Example fixes**
1. Avoid creating entities within callbacks in DynamicHelloWorldExample.
2. Remove Asio dependency from DeadlineQoSExample.
6. **Repository fixes**
1. Remove 2.7.x as active branch.
7. **Community supported platforms**
1. Include right header when building for iOS.

.. 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*.
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ autodispose
autoenable
autoid
automake
backoff
benchmarking
bitfield
Bitfields
Expand Down

0 comments on commit 4923617

Please sign in to comment.