Skip to content

Commit

Permalink
Version 2.11.1 release notes (#528)
Browse files Browse the repository at this point in the history 
* Refs #19182: Version 2.11.1 release notes

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

* Refs #19182: Applied suggestions

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

---------

Signed-off-by: Javier Santiago <[email protected]>
  • Loading branch information
@jsan-rt
jsan-rt authored Jul 18, 2023
1 parent 99679c8 commit 5df43f9
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 87 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.11.0'
version = u'2.11.1'
# The full version, including alpha/beta/rc tags.
release = u'2.11.0'
release = u'2.11.1'

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

Version 2.11.0
Version 2.11.1
==============

This minor release includes several 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.11.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.5.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.5.1>`_.
Furthermore, if upgrading to v2.11.0, it is also recommended to upgrade Fast CDR to
`v1.1.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.1.0>`_.

This release includes the following **features**:

1. :ref:`Ignore every local endpoint within the DomainParticipant preventing local matching
<property_ignore_local_endpoints>`.
2. Extend DynamicDataHelper API providing a ``print`` overload with ``std::ostream`` as parameter.
3. :ref:`typelookup_config`.
4. Static Discovery XSD Schema.

This release includes the following **improvements**:

1. **Fast DDS improvements**
1. Assign minimum available participant ID to new participants.
2. Export symbols correctly on ContentFilteredTopic.
3. Improve content filter expression parameters check and verbosity.
4. Check TCP headers endianness.
5. Security module: distinguished names (DN) comparison.
2. **Fast DDS deprecation**
1. DDS:Crypto:AES-GCM-GMAC configuration using Property Policy QoS (security vulnerability).
3. **CI improvements**
1. Include BitmapRange unit tests.
2. Support for running some tests in parallel.
3. Windows workflow.
4. **Build system**
1. Improve CMake target loading. Removal of ``FASTDDS_STATIC`` CMake option.
2. Avoid auto-linkage using CMake.
5. **Dependencies**
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.5.1.
2. Upgrade Fast CDR submodule to v1.1.0.
6. **Examples**
1. Admit XML configuration files in AdvanceConfigurationExample.
2. New Discovery Server example.
1. Correct CONTRIBUTING.md typo
2. Improve validation on PID_PROPERTY_LIST deserialization
3. Apply eProsima brand style to Fast DDS repository
4. Fix spelling mistake: SUBSTRACTION to SUBTRACTION

This release includes the following **fixes**:

1. **Fast DDS bugfixes**
1. Fix crash when creating two participants with the same fixed participant ID.
2. Fix crash when calling
:cpp:func:`on_requested_deadline_missed() <eprosima::fastdds::dds::DataReaderListener::on_requested_deadline_missed>`
callback.
3. Fix crashes caused by not capturing every Fast CDR exception.
4. Correctly resolve aliases in DDSSQLFilter.
5. Wait for log background thread initialization on the first queued entry.
6. Fix data race when accessing ``WRITE_PARAM_DEFAULT`` static variable.
7. Fix partition copy in QoS.
8. Fix Data-Sharing delivery when data_count is zero.
9. Fix API Fast DDS v2.10.0 API break calling correctly.
:cpp:func:`on_participant_discovery() <eprosima::fastdds::dds::DomainParticipantListener::on_participant_discovery>`
callbacks.
10. Security module: Honor :ref:`allow_unauthenticated_section` flag.
11. Fix concurrent access to
:cpp:func:`load_profiles() <eprosima::fastdds::dds::DomainParticipantFactory::load_profiles>`.
12. Fix UBSan (Undefined Behavior Sanitizer) issues.
13. Improve Doxygen documentation about DomainParticipantListener discovery callbacks.
2. XSD fixes
1. Set TransportDescriptor kind parameter as optional.
2. Correctly assign QoS to the proper endpoint.
3. Add missing tags.
3. CI fixes
1. Fix null dereference in fuzzer code.
2. Limit Thread Sanitizer memory usage to prevent runner shutdown.
3. Use correct time unit in latency tests.
4. Run communication tests.
4. Examples
1. Correct DDS entity deletion order.
5. Installer generation
1. Add documentation fallback when the documentation tag is not found.
6. Repository
1. Remove 2.1.x as active branch.
2. Remove 2.8.x as active branch.
7. Non Tier 1 support
1. Fix build on MSVC 19.36.
2. Forward compatibility with Boost inter-process 1.74+.
3. Include missing header files required for compiling with GCC 13.
4. QNX build fixes.
5. Fix build issues in RPM systems.
1. Fixed long-standing reconnection issue on SHM transport
2. Added missing include
3. Fixed Boost handle usage regression
4. Fix StatelessWriter locators filtering
5. Avoid double definition of FASTDDS_ENFORCE_LOG_INFO
6. Explicitly register type object in ContentFilteredTopicExample
7. Properly handle zero-sized payloads on dynamic memory payload pools

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

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

This release includes the following **features**:

1. :ref:`Ignore every local endpoint within the DomainParticipant preventing local matching
<property_ignore_local_endpoints>`.
2. Extend DynamicDataHelper API providing a ``print`` overload with ``std::ostream`` as parameter.
3. :ref:`typelookup_config`.
4. Static Discovery XSD Schema.

This release includes the following **improvements**:

1. **Fast DDS improvements**
1. Assign minimum available participant ID to new participants.
2. Export symbols correctly on ContentFilteredTopic.
3. Improve content filter expression parameters check and verbosity.
4. Check TCP headers endianness.
5. Security module: distinguished names (DN) comparison.
2. **Fast DDS deprecation**
1. DDS:Crypto:AES-GCM-GMAC configuration using Property Policy QoS (security vulnerability).
3. **CI improvements**
1. Include BitmapRange unit tests.
2. Support for running some tests in parallel.
3. Windows workflow.
4. **Build system**
1. Improve CMake target loading. Removal of ``FASTDDS_STATIC`` CMake option.
2. Avoid auto-linkage using CMake.
5. **Dependencies**
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.5.1.
2. Upgrade Fast CDR submodule to v1.1.0.
6. **Examples**
1. Admit XML configuration files in AdvanceConfigurationExample.
2. New Discovery Server example.

This release includes the following **fixes**:

1. **Fast DDS bugfixes**
1. Fix crash when creating two participants with the same fixed participant ID.
2. Fix crash when calling
:cpp:func:`on_requested_deadline_missed() <eprosima::fastdds::dds::DataReaderListener::on_requested_deadline_missed>`
callback.
3. Fix crashes caused by not capturing every Fast CDR exception.
4. Correctly resolve aliases in DDSSQLFilter.
5. Wait for log background thread initialization on the first queued entry.
6. Fix data race when accessing ``WRITE_PARAM_DEFAULT`` static variable.
7. Fix partition copy in QoS.
8. Fix Data-Sharing delivery when data_count is zero.
9. Fix API Fast DDS v2.10.0 API break calling correctly.
:cpp:func:`on_participant_discovery() <eprosima::fastdds::dds::DomainParticipantListener::on_participant_discovery>`
callbacks.
10. Security module: Honor :ref:`allow_unauthenticated_section` flag.
11. Fix concurrent access to
:cpp:func:`load_profiles() <eprosima::fastdds::dds::DomainParticipantFactory::load_profiles>`.
12. Fix UBSan (Undefined Behavior Sanitizer) issues.
13. Improve Doxygen documentation about DomainParticipantListener discovery callbacks.
2. XSD fixes
1. Set TransportDescriptor kind parameter as optional.
2. Correctly assign QoS to the proper endpoint.
3. Add missing tags.
3. CI fixes
1. Fix null dereference in fuzzer code.
2. Limit Thread Sanitizer memory usage to prevent runner shutdown.
3. Use correct time unit in latency tests.
4. Run communication tests.
4. Examples
1. Correct DDS entity deletion order.
5. Installer generation
1. Add documentation fallback when the documentation tag is not found.
6. Repository
1. Remove 2.1.x as active branch.
2. Remove 2.8.x as active branch.
7. Non Tier 1 support
1. Fix build on MSVC 19.36.
2. Forward compatibility with Boost inter-process 1.74+.
3. Include missing header files required for compiling with GCC 13.
4. QNX build fixes.
5. Fix build issues in RPM systems.

.. 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 5df43f9

Please sign in to comment.