From c10972f779bf4ad77ec89164f2cc66735c579cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Luis=20Bueno=20L=C3=B3pez?= <69244257+JLBuenoLopez-eProsima@users.noreply.github.com> Date: Thu, 19 Jan 2023 07:54:22 +0100 Subject: [PATCH] Bump version to v2.9.1 and upload Fast DDS v2.9.1 release notes (#447) * Refs #16802: bump version to v2.9.1 Signed-off-by: JLBuenoLopez-eProsima * Refs #16802: upload Fast DDS v2.9.1 release notes Signed-off-by: JLBuenoLopez-eProsima Signed-off-by: JLBuenoLopez-eProsima --- docs/03-exports/aliases-api.include | 1 + docs/conf.py | 4 +- docs/notes/notes.rst | 74 +++++-------------------- docs/notes/previous_versions/v2.9.0.rst | 69 +++++++++++++++++++++++ docs/spelling_wordlist.txt | 2 + 5 files changed, 88 insertions(+), 62 deletions(-) create mode 100644 docs/notes/previous_versions/v2.9.0.rst diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index cba7c7a4e..99399d9c8 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -20,6 +20,7 @@ .. |DataReader::take_next_instance-api| replace:: :cpp:func:`DataReader::take_next_instance()` .. |DataReader::take_next_sample-api| replace:: :cpp:func:`DataReader::take_next_sample()` .. |DataReader::take_w_condition-api| replace:: :cpp:func:`DataReader::take_w_condition()` +.. |DataReader::get_first_untaken_info-api| replace:: :cpp:func:`DataReader::get_first_untaken_info()` .. |DataReader::return_loan-api| replace:: :cpp:func:`DataReader::return_loan()` .. |DataReader::wait_for_unread_message()| replace:: :cpp:func:`DataReader::wait_for_unread_message()` .. |DataReaderListener-api| replace:: :cpp:class:`DataReaderListener ` diff --git a/docs/conf.py b/docs/conf.py index a17829fdf..01892a959 100644 --- 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.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. diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst index c113547c9..069117c09 100644 --- a/docs/notes/notes.rst +++ b/docs/notes/notes.rst @@ -5,70 +5,23 @@ Information about the release lifecycle can be found `here `_. -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`, -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 `_. - Furthermore, if upgrading to v2.9.0, it is also recommended to upgrade Fast CDR to - `v1.0.26 `_. - -This release includes the following **features**: - -1. New log macros :c:macro:`EPROSIMA_LOG_INFO `, - :c:macro:`EPROSIMA_LOG_WARNING ` and :c:macro:`EPROSIMA_LOG_ERROR `. -2. Add ``ENABLE_OLD_LOG_MACROS`` CMake option to support - :ref:`disabling the compilation of previous log macros `. - -This release includes the following **behavior changes**: - -1. Default :ref:`memory management policy ` set to - :cpp:enumerator:`PREALLOCATED_WITH_REALLOC_MEMORY_MODE`. -2. Statistics metrics are only calculated/accumulated when their corresponding DataWriter is enabled in - :ref:`Fast DDS Statistics Module `. -3. Enable ``FASTDDS_STATISTICS`` :ref:`CMake option ` 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()` - 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()`. + 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 @@ -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 diff --git a/docs/notes/previous_versions/v2.9.0.rst b/docs/notes/previous_versions/v2.9.0.rst new file mode 100644 index 000000000..0ab069170 --- /dev/null +++ b/docs/notes/previous_versions/v2.9.0.rst @@ -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`, +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 `_. + Furthermore, if upgrading to v2.9.0, it is also recommended to upgrade Fast CDR to + `v1.0.26 `_. + +This release includes the following **features**: + +1. New log macros :c:macro:`EPROSIMA_LOG_INFO `, + :c:macro:`EPROSIMA_LOG_WARNING ` and :c:macro:`EPROSIMA_LOG_ERROR `. +2. Add ``ENABLE_OLD_LOG_MACROS`` CMake option to support + :ref:`disabling the compilation of previous log macros `. + +This release includes the following **behavior changes**: + +1. Default :ref:`memory management policy ` set to + :cpp:enumerator:`PREALLOCATED_WITH_REALLOC_MEMORY_MODE`. +2. Statistics metrics are only calculated/accumulated when their corresponding DataWriter is enabled in + :ref:`Fast DDS Statistics Module `. +3. Enable ``FASTDDS_STATISTICS`` :ref:`CMake option ` 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()` + 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*. diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 40f6201aa..1028ac772 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -33,6 +33,7 @@ booleans bugfixes cancelled Cannonical +CCache CDR centric Centric @@ -90,6 +91,7 @@ fastcdr fastdds fastddsgen foonathan +fuzzer GCC GCM getter