From f39df94af5df2adf5e57a7883d2ed41371f1bf55 Mon Sep 17 00:00:00 2001 From: Miguel Company Date: Mon, 20 Sep 2021 12:28:16 +0200 Subject: [PATCH] 2.4.0 (#286) * Refs 12525. Removed warning on data sharing. Signed-off-by: Miguel Company * Refs 12525. Notes for 2.4.0. Signed-off-by: Miguel Company * Refs 12525. Bump to 2.4.0. Signed-off-by: Miguel Company --- docs/conf.py | 4 +- docs/fastdds/transport/datasharing.rst | 6 --- docs/notes/notes.rst | 66 +++++++++++++++---------- docs/notes/previous_versions/v2.3.4.rst | 37 ++++++++++++++ 4 files changed, 78 insertions(+), 35 deletions(-) create mode 100644 docs/notes/previous_versions/v2.3.4.rst diff --git a/docs/conf.py b/docs/conf.py index b5464562e..9f6db22e8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -294,9 +294,9 @@ def configure_doxyfile( # built documents. # # The short X.Y version. -version = u'2.3.4' +version = u'2.4.0' # The full version, including alpha/beta/rc tags. -release = u'2.3.4' +release = u'2.4.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/fastdds/transport/datasharing.rst b/docs/fastdds/transport/datasharing.rst index bfc02a4b7..ff6b20c9f 100644 --- a/docs/fastdds/transport/datasharing.rst +++ b/docs/fastdds/transport/datasharing.rst @@ -151,12 +151,6 @@ Configuring a user-defined directory may be useful in some scenarios: * To select a file system with Huge TLB enabled for the memory-mapped files. * To allow data-sharing delivery between containers that mount the same container. -.. warning:: - - Currently the configuration of shared memory directory is not supported. - As a result, any directory set by the user will be discarded, - and the default directory configured for the current system is used. - DataReader and DataWriter history coupling ------------------------------------------ diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst index b84bf513d..62b1e6c8e 100644 --- a/docs/notes/notes.rst +++ b/docs/notes/notes.rst @@ -1,37 +1,48 @@ .. _release_notes: -Version 2.3.4 +Version 2.4.0 ============= -This release includes the following **improvements**: +This minor release is API compatible with the previous minor release, but introduces **ABI breaks** on +two of the three public APIs: -1. Support of googletest using colcon -2. Network latency reports source participant -3. Update Fast DDS Gen to v2.0.2 +* 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. -This release includes the following **bugfixes**: +* 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. -1. Fix mutex lock count on :class:`PDPListener` -2. Limit :class:`SequenceNumberSet` number of bits on deserialization -3. Fix segmentation fault on discovery server -4. Fix deadlock with security and timers -5. Fix bug using not protected code in a test -6. Fix deadlock with :class:`LivelinessManager` -7. Fix interval loop on events -8. Fix run event when was cancelled -9. Validate sequence range on :class:`CDRMessage::readSequenceNumberSet` -10. Fix subscription throughput data generation -11. Allow examples to build on QNX -12. Fix code on SHM clean -13. Accept Statistics DataWriters in Discovery Server -14. Fix read/take behavior when a future change is found -15. Correctly handle deserialization errors on ``read_next_sample()`` / ``take_next_sample()`` -16. Fixing :class:`SequenceNumberSet_t` deserialization -17. Proper history clean up when a reader unmatches a writer -18. Unprotected code loaning samples -19. Fix publication throughput statistic on volatile writers -20. Fix Fast DDS CLI server name -21. Several fixes in examples and tests +* Old Fast-RTPS high-level API remains ABI compatible. + +This minor release includes the following **features**: + +* :ref:`Conditions and Wait-sets ` implementation. +* :ref:`Flow controllers `. +* :ref:`Configure Discovery Server locators using names `. +* :ref:`Modifying remote servers list at run time `. +* :ref:`Environment file override `. + +It also includes the following **improvements**: + +* Allow setting custom folder for :ref:`data-sharing ` files. +* Allow setting persistence guid with static discovery. +* Check for NDEBUG in logInfo. +* Removed old unused CMake code. +* Fixed TLS behavior on TCP example. +* Prepare API for easy integration of python bindings. +* Improved statistics performance. + +Some important **bugfixes** are also included: + +* Fixed order of returned samples on topics with keys. +* Allow updating partitions to an empty set. +* Correctly propagate DomainParticipantQos updates. +* Avoid a volatile data-sharing reader to block a writer. +* Correctly give priority to intra-process over data-sharing. +* Fixed reallocation issue on LivelinessManager. +* Fixed deadline issue on volatile DataWriter +* Fixed STRICT_REALTIME silently not active with Unix POSIX systems. +* Fixed build errors with OpenSSL 3.0 .. note:: If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL @@ -41,6 +52,7 @@ This release includes the following **bugfixes**: Previous versions ================= +.. include:: previous_versions/v2.3.4.rst .. include:: previous_versions/v2.3.3.rst .. include:: previous_versions/v2.3.2.rst .. include:: previous_versions/v2.3.1.rst diff --git a/docs/notes/previous_versions/v2.3.4.rst b/docs/notes/previous_versions/v2.3.4.rst new file mode 100644 index 000000000..b57aa915e --- /dev/null +++ b/docs/notes/previous_versions/v2.3.4.rst @@ -0,0 +1,37 @@ +Version 2.3.4 +^^^^^^^^^^^^^ + +This release includes the following **improvements**: + +1. Support of googletest using colcon +2. Network latency reports source participant +3. Update Fast DDS Gen to v2.0.2 + +This release includes the following **bugfixes**: + +1. Fix mutex lock count on :class:`PDPListener` +2. Limit :class:`SequenceNumberSet` number of bits on deserialization +3. Fix segmentation fault on discovery server +4. Fix deadlock with security and timers +5. Fix bug using not protected code in a test +6. Fix deadlock with :class:`LivelinessManager` +7. Fix interval loop on events +8. Fix run event when was cancelled +9. Validate sequence range on :class:`CDRMessage::readSequenceNumberSet` +10. Fix subscription throughput data generation +11. Allow examples to build on QNX +12. Fix code on SHM clean +13. Accept Statistics DataWriters in Discovery Server +14. Fix read/take behavior when a future change is found +15. Correctly handle deserialization errors on ``read_next_sample()`` / ``take_next_sample()`` +16. Fixing :class:`SequenceNumberSet_t` deserialization +17. Proper history clean up when a reader unmatches a writer +18. Unprotected code loaning samples +19. Fix publication throughput statistic on volatile writers +20. Fix Fast DDS CLI server name +21. Several fixes in examples and tests + +.. 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*.