Skip to content

Commit

Permalink
Bump version to v2.9.1 and upload Fast DDS v2.9.1 release notes (#447)
Browse files Browse the repository at this point in the history 
* Refs #16802: bump version to v2.9.1

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

* Refs #16802: upload Fast DDS v2.9.1 release notes

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

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
  • Loading branch information
@JLBuenoLopez
JLBuenoLopez committed Jan 19, 2023
1 parent 6e0b42e commit c10972f
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 62 deletions.
1 change: 1 addition & 0 deletions docs/03-exports/aliases-api.include
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
.. |DataReader::take_next_instance-api| replace:: :cpp:func:`DataReader::take_next_instance()<eprosima::fastdds::dds::DataReader::take_next_instance>`
.. |DataReader::take_next_sample-api| replace:: :cpp:func:`DataReader::take_next_sample()<eprosima::fastdds::dds::DataReader::take_next_sample>`
.. |DataReader::take_w_condition-api| replace:: :cpp:func:`DataReader::take_w_condition()<eprosima::fastdds::dds::DataReader::take_w_condition>`
.. |DataReader::get_first_untaken_info-api| replace:: :cpp:func:`DataReader::get_first_untaken_info()<eprosima::fastdds::dds::DataReader::get_first_untaken_info>`
.. |DataReader::return_loan-api| replace:: :cpp:func:`DataReader::return_loan()<eprosima::fastdds::dds::DataReader::return_loan>`
.. |DataReader::wait_for_unread_message()| replace:: :cpp:func:`DataReader::wait_for_unread_message()<eprosima::fastdds::dds::DataReader::wait_for_unread_mesage>`
.. |DataReaderListener-api| replace:: :cpp:class:`DataReaderListener <eprosima::fastdds::dds::DataReaderListener>`
Expand Down
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.9.0'
version = u'2.9.1'
# The full version, including alpha/beta/rc tags.
release = u'2.9.0'
release = u'2.9.1'

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

Version 2.9.0
Version 2.9.1
=============

This minor release includes several new features (new log macros to avoid conflicts with external libraries), behavior
change (default memory management policy is no longer
:cpp:enumerator:`PREALLOCATED_MEMORY_MODE<eprosima::fastrtps::rtps::MemoryManagementPolicy::PREALLOCATED_MEMORY_MODE>`,
enable by default Fast DDS Statistics module but only taking statistics metrics if the corresponding Statistics
DataWriter is enabled), performance improvements, CI improvements (including address sanitizer jobs), 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.9.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.3.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.3.0>`_.
Furthermore, if upgrading to v2.9.0, it is also recommended to upgrade Fast CDR to
`v1.0.26 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.26>`_.

This release includes the following **features**:

1. New log macros :c:macro:`EPROSIMA_LOG_INFO <EPROSIMA_LOG_INFO>`,
:c:macro:`EPROSIMA_LOG_WARNING <EPROSIMA_LOG_WARNING>` and :c:macro:`EPROSIMA_LOG_ERROR <EPROSIMA_LOG_ERROR>`.
2. Add ``ENABLE_OLD_LOG_MACROS`` CMake option to support
:ref:`disabling the compilation of previous log macros <old_log_macros_disable>`.

This release includes the following **behavior changes**:

1. Default :ref:`memory management policy <memorymanagementpolicy>` set to
:cpp:enumerator:`PREALLOCATED_WITH_REALLOC_MEMORY_MODE<eprosima::fastrtps::rtps::MemoryManagementPolicy::PREALLOCATED_WITH_REALLOC_MEMORY_MODE>`.
2. Statistics metrics are only calculated/accumulated when their corresponding DataWriter is enabled in
:ref:`Fast DDS Statistics Module <statistics_enable_datawriters>`.
3. Enable ``FASTDDS_STATISTICS`` :ref:`CMake option <cmake_options>` by default.

This release includes the following **improvements**:

1. CI improvements:
1. Add address sanitizer job for Fast DDS library.
2. Add address sanitizer job for Discovery Server test suite.
2. Upgrade Fast CDR submodule.

This release includes the following **bugfixes**:

1. Synchronization fixes:
1. Fix deadlock when removing remote DomainParticipants by expired liveliness when using Security.
2. Protect :cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`
avoiding null reference.
3. Fix data race on ``WriterProxy::stop`` while TimedEvent is being triggered.
4. Protect creation/destruction of Boost's ``named_mutex``.
2. CI fixes:
1. Fix Statistics Module test suite.
2. Fix recurring data races in test suite.
3. Fix thread sanitizer job keeping Ubuntu 20.04.
3. Other:
1. Fix Topic creation when registering a type name different from the internal TypeSupport name.
2. Fix communication with asymmetric :ref:`discovery_ignore_flags`.
3. Several dependencies fixes upgrading to Ubuntu 22.04.
4. Disable error logged when DomainParticipant profile is not found.
5. Fix CMake for Fast DDS use as submodule.
6. Upgrade internal type supports generated with Fast DDS-Gen v2.3.0.
7. Other minor fixes.
1. **Synchronization fixes**:
1. Fix deadlock in Writer Liveliness Protocol (WLP) using intraprocess.
2. Fix data race in
:cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`.
3. Fix deadlock on TLS closure.
2. **Other fixes**:
1. Fix notification lost.
2. Fix ``total_read_`` to be consistent with Reader's History after |DataReader::get_first_untaken_info-api|.
3. Use shared pointers for internal singletons.
4. Support CCache on Windows.
5. Avoid null dereference on fuzzer.
6. 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
Expand All @@ -78,6 +31,7 @@ This release includes the following **bugfixes**:
Previous versions
=================

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

This minor release includes several new features (new log macros to avoid conflicts with external libraries), behavior
change (default memory management policy is no longer
:cpp:enumerator:`PREALLOCATED_MEMORY_MODE<eprosima::fastrtps::rtps::MemoryManagementPolicy::PREALLOCATED_MEMORY_MODE>`,
enable by default Fast DDS Statistics module but only taking statistics metrics if the corresponding Statistics
DataWriter is enabled), performance improvements, CI improvements (including address sanitizer jobs), 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.9.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.3.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.3.0>`_.
Furthermore, if upgrading to v2.9.0, it is also recommended to upgrade Fast CDR to
`v1.0.26 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.26>`_.

This release includes the following **features**:

1. New log macros :c:macro:`EPROSIMA_LOG_INFO <EPROSIMA_LOG_INFO>`,
:c:macro:`EPROSIMA_LOG_WARNING <EPROSIMA_LOG_WARNING>` and :c:macro:`EPROSIMA_LOG_ERROR <EPROSIMA_LOG_ERROR>`.
2. Add ``ENABLE_OLD_LOG_MACROS`` CMake option to support
:ref:`disabling the compilation of previous log macros <old_log_macros_disable>`.

This release includes the following **behavior changes**:

1. Default :ref:`memory management policy <memorymanagementpolicy>` set to
:cpp:enumerator:`PREALLOCATED_WITH_REALLOC_MEMORY_MODE<eprosima::fastrtps::rtps::MemoryManagementPolicy::PREALLOCATED_WITH_REALLOC_MEMORY_MODE>`.
2. Statistics metrics are only calculated/accumulated when their corresponding DataWriter is enabled in
:ref:`Fast DDS Statistics Module <statistics_enable_datawriters>`.
3. Enable ``FASTDDS_STATISTICS`` :ref:`CMake option <cmake_options>` by default.

This release includes the following **improvements**:

1. CI improvements:
1. Add address sanitizer job for Fast DDS library.
2. Add address sanitizer job for Discovery Server test suite.
2. Upgrade Fast CDR submodule.

This release includes the following **bugfixes**:

1. Synchronization fixes:
1. Fix deadlock when removing remote DomainParticipants by expired liveliness when using Security.
2. Protect :cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`
avoiding null reference.
3. Fix data race on ``WriterProxy::stop`` while TimedEvent is being triggered.
4. Protect creation/destruction of Boost's ``named_mutex``.
2. CI fixes:
1. Fix Statistics Module test suite.
2. Fix recurring data races in test suite.
3. Fix thread sanitizer job keeping Ubuntu 20.04.
3. Other:
1. Fix Topic creation when registering a type name different from the internal TypeSupport name.
2. Fix communication with asymmetric :ref:`discovery_ignore_flags`.
3. Several dependencies fixes upgrading to Ubuntu 22.04.
4. Disable error logged when DomainParticipant profile is not found.
5. Fix CMake for Fast DDS use as submodule.
6. Upgrade internal type supports generated with Fast DDS-Gen v2.3.0.
7. Other minor fixes.

.. 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*.
2 changes: 2 additions & 0 deletions docs/spelling_wordlist.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ booleans
bugfixes
cancelled
Cannonical
CCache
CDR
centric
Centric
Expand Down Expand Up @@ -90,6 +91,7 @@ fastcdr
fastdds
fastddsgen
foonathan
fuzzer
GCC
GCM
getter
Expand Down

0 comments on commit c10972f

Please sign in to comment.