From a63c778c815f97655bf8548e386668e2ef745695 Mon Sep 17 00:00:00 2001 From: Miguel Company Date: Thu, 9 Jun 2022 12:56:51 +0200 Subject: [PATCH] 2.6.1 (#373) * Refs #14579. Bump version to 2.6.1 Signed-off-by: Miguel Company * Refs #14579. Copy current notes to previous/2.6.0 Signed-off-by: Miguel Company * Refs #14579. Notes for 2.6.1 Signed-off-by: Miguel Company --- docs/conf.py | 4 +-- docs/notes/notes.rst | 47 +++++++------------------ docs/notes/previous_versions/v2.6.0.rst | 46 ++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 36 deletions(-) create mode 100644 docs/notes/previous_versions/v2.6.0.rst diff --git a/docs/conf.py b/docs/conf.py index 7e48648ce..95ad5816f 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.6.0' +version = u'2.6.1' # The full version, including alpha/beta/rc tags. -release = u'2.6.0' +release = u'2.6.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 a3a0bd015..b4cc8483a 100644 --- a/docs/notes/notes.rst +++ b/docs/notes/notes.rst @@ -3,46 +3,24 @@ Information about the release lifecycle can be found `here `_. -Version 2.6.0 +Version 2.6.1 ============= -This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on two of the three -public APIs: +This release includes the following **improvements**: -* Methods and attributes have been added on several classes of the DDS-PIM high-level API, so indexes of symbols on - dynamic libraries may have changed. Some API is also being deprecated. -* Methods and attributes have been added on several classes of the RTPS low-level API, so indexes of symbols on dynamic - libraries may have changed. -* Old Fast-RTPS high-level API remains ABI compatible. - -This minor release includes the following **features**: - -1. :ref:`Allow modifying remote server locators at runtime ` -2. :ref:`Add statistics physical information to DATA[p] using properties ` -3. :ref:`Content filter discovery information RTPS API ` -4. Endpoint discovery RTPS API -5. ``on_sample_lost`` RTPS API -6. Transport layer API extension -7. :ref:`XML support for Fast DDS CLI ` -8. :ref:`New exchange format to reduce bandwidth in Static Discovery ` - -It also includes the following **improvements**: - -1. Support lowercase keywords on SQL filter -2. Separate initialization and enabling of BuiltinProtocols -3. Add ``disable_positive_acks`` to Static Discovery XML -4. Several updates in the DDS-PIM API -5. Support for octet vectors on XML parser -6. Update README and roadmap -7. Update Fast-CDR submodule to v1.0.24 -8. Add new CMake option ``APPEND_PROJECT_NAME_TO_INCLUDEDIR`` +1. Support for :ref:`writer side content filtering ` +2. Support hexadecimal values on SQL filter +3. Support for :cpp:func:`DataWriter::get_key_value()` +4. Support for :cpp:func:`DataReader::lookup_instance()` +5. Support for SampleLostStatus on DataReader +6. Improved doxygen documentation Some **bugfixes** are also included: -1. Fix MatchedStatus ``last_*_handle`` -2. Fix recommended statistics DataReaderQos to enable backwards compatibility -3. Fixes for supporting Python bindings in Windows platforms -4. Fix publishing physical data on statistics topic +1. Fixed several lock order inversion issues +2. Fixed data race when closing UDP channels +3. Fixed empty partition validation checks +4. Fixed corner case with reliable writers and samples with a huge number of fragments 5. Other minor fixes and improvements .. note:: @@ -53,6 +31,7 @@ Some **bugfixes** are also included: Previous versions ================= +.. include:: previous_versions/v2.6.0.rst .. include:: previous_versions/v2.5.1.rst .. include:: previous_versions/v2.5.0.rst .. include:: previous_versions/v2.4.2.rst diff --git a/docs/notes/previous_versions/v2.6.0.rst b/docs/notes/previous_versions/v2.6.0.rst new file mode 100644 index 000000000..38ca7e4bc --- /dev/null +++ b/docs/notes/previous_versions/v2.6.0.rst @@ -0,0 +1,46 @@ +Version 2.6.0 +^^^^^^^^^^^^^ + +This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on two of the three +public APIs: + +* Methods and attributes have been added on several classes of the DDS-PIM high-level API, so indexes of symbols on + dynamic libraries may have changed. Some API is also being deprecated. +* Methods and attributes have been added on several classes of the RTPS low-level API, so indexes of symbols on dynamic + libraries may have changed. +* Old Fast-RTPS high-level API remains ABI compatible. + +This minor release includes the following **features**: + +1. :ref:`Allow modifying remote server locators at runtime ` +2. :ref:`Add statistics physical information to DATA[p] using properties ` +3. :ref:`Content filter discovery information RTPS API ` +4. Endpoint discovery RTPS API +5. ``on_sample_lost`` RTPS API +6. Transport layer API extension +7. :ref:`XML support for Fast DDS CLI ` +8. :ref:`New exchange format to reduce bandwidth in Static Discovery ` + +It also includes the following **improvements**: + +1. Support lowercase keywords on SQL filter +2. Separate initialization and enabling of BuiltinProtocols +3. Add ``disable_positive_acks`` to Static Discovery XML +4. Several updates in the DDS-PIM API +5. Support for octet vectors on XML parser +6. Update README and roadmap +7. Update Fast-CDR submodule to v1.0.24 +8. Add new CMake option ``APPEND_PROJECT_NAME_TO_INCLUDEDIR`` + +Some **bugfixes** are also included: + +1. Fix MatchedStatus ``last_*_handle`` +2. Fix recommended statistics DataReaderQos to enable backwards compatibility +3. Fixes for supporting Python bindings in Windows platforms +4. Fix publishing physical data on statistics topic +5. 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 + files using *fastddsgen*. + If you are upgrading from any older version, regenerating the code is *highly recommended*.