diff --git a/docs/conf.py b/docs/conf.py index e8ebb4413..53dfe3724 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.12.0' +version = u'2.12.1' # The full version, including alpha/beta/rc tags. -release = u'2.12.0' +release = u'2.12.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 90b1a04a7..b5510e47e 100644 --- a/docs/notes/notes.rst +++ b/docs/notes/notes.rst @@ -5,97 +5,46 @@ Information about the release lifecycle can be found `here `_. -Version 2.12.0 +Version 2.12.1 ============== -.. note:: - - This release upgrades the following Fast DDS dependencies: - - * `Fast CDR v2.0.0 `_ - * `Fast DDS-Gen v3.0.1 `_ - - Please, read also the release notes of - `Fast DDS-Gen v3.0.0 `_ to be aware of every possible - break in the application code. - - As Fast DDS dependencies have been upgraded to new major releases, depending on the types defined in the IDL files, - it might be required to modify the user application source code besides recompiling it (more information can be found - in the corresponding release notes). - -.. note:: - - There is a minor API break with previous v2.x versions: ``MEMBER_INVALID`` identifier was declared using ``#define``. - In order to prevent polluting the user workspace, it has been transformed into a ``constexpr`` within - ``eprosima::fastrtps::types`` namespace. - -This release includes the following **features**: - -1. :ref:`New participant property ` to configure SHM - transport metatraffic behavior. -2. Exposed custom payload pool on DDS :ref:`DataWriter ` and - :ref:`DataReader ` declaration. - - 1. Feature example. - -3. :ref:`Processing environment variables in XML text `. -4. Dependencies - - 1. Upgrade internal type supports using latest Fast DDS-Gen release v3.0.0. - This release introduces the following features: - - 1. `Support for @optional builtin annotation `. - 2. `Support for @extensibility builtin annotation `. - - 2. Upgrade Fast CDR submodule to v2.0.0 introducing XCDR encoding version 2. - This release includes the following **improvements**: -1. ``fixed_string`` comparison operators. -2. Remove mutex from `TimedEventImpl` (#3745, #3760) -3. Performance improvements on intraprocess and datasharing. -4. Improve Shared Memory resilience to crashing participants. -5. Improve scripts shebang portability. -6. Use ``foonathan_memory`` to reduce allocations in SharedMemManager. +1. Support for linking with Fast CDR v1. +2. The period for the timer within the :ref:`disablepositiveacksqospolicy` is now updatable. +3. Log error message upon receiver resource creation failure. +4. CI and repository improvements. +5. Simplify code in CDRMessage. This release includes the following **fixes**: 1. **Fast DDS bugfixes** - 1. Fixed XMLParser null-dereference when parsing log configuration. - 2. Allow participant XML profiles with no ```` tag. - 3. Fix encapsulation format in Writer Liveliness Protocol. - 4. Fix :cpp:func:`DomainParticipant::register_remote_type` - return when negotiating type. - 5. Fix strict real-time feature when using Flow Controller feature. - 6. Fix ParameterPropertyList increment operators. - 7. Fix bad-free when receiving malformed DATA submessage. - 8. Fix asymmetric whitelist matching. - 9. Fix heap-use-after-free on XMLElementParser. - 10. Fix History remove change return statement. -2. CI fixes - 1. Fix RemoteBuiltinEndpointHonoring blackbox test. - 2. Improve repository workflows. - 3. Use `FASTRTPS_NO_LIB` on unittest root folder. - 4. Fix Windows workflow. -3. Tools - 1. Remove C++11 check in ``fastdds-discovery-server`` CLI tool. -4. Examples - 1. Fix HelloWorldDataSharing data type. -5. Documentation - 1. Doxygen typos. -6. Repository - 1. Remove 2.9.x as active branch. -7. Non Tier 1 support - 1. Fixed SHM in 32-bit architectures. - 2. Fix warning on Win32 architecture. + + 1. Fix transient local durability for reliable readers using intra-process and data-sharing. + 2. Use STL implementation of Timed/RecursiveTimedMutex when MSVC >= 19.36. + 3. Fix updatability of immutable DataWriterQos. + 4. Fix the clang build for clang 14. + 5. Fix remote locators filtering when whitelist provided. + 6. Fix Data Race when updating liveliness changed in WLP. + 7. Add XML parser bit_bound bounds check. + 8. Fix missing mandatory attribute check in XML parser struct type. + 9. SHM transport: ignore non-existing segment on pop. + 10. Fix: mac address overflow on Windows. + +2. CI fixes: + + 1. Fix flow controllers unit tests compilation when using Fast CDR from thirdparty. + 2. PubSubAsReliable test fix. + 3. FileWatchTest fix for github windows CI. .. note:: - Upgrading to version 2.12.0 **requires** to regenerate generated source from IDL files using - `Fast DDS-Gen v3.0.1 `_. + When upgrading to version 2.12.1 it is **advisable** to regenerate generated source from IDL files + using `Fast DDS-Gen v3.1.0 `_. Previous versions ================= +.. include:: previous_versions/v2.12.0.rst .. include:: previous_versions/v2.11.2.rst .. include:: previous_versions/v2.11.1.rst .. include:: previous_versions/v2.11.0.rst diff --git a/docs/notes/previous_versions/v2.12.0.rst b/docs/notes/previous_versions/v2.12.0.rst new file mode 100644 index 000000000..5e064bd73 --- /dev/null +++ b/docs/notes/previous_versions/v2.12.0.rst @@ -0,0 +1,88 @@ +Version 2.12.0 +^^^^^^^^^^^^^^ + +.. note:: + + This release upgrades the following Fast DDS dependencies: + + * `Fast CDR v2.0.0 `_ + * `Fast DDS-Gen v3.0.1 `_ + + Please, read also the release notes of + `Fast DDS-Gen v3.0.0 `_ to be aware of every possible + break in the application code. + + As Fast DDS dependencies have been upgraded to new major releases, depending on the types defined in the IDL files, + it might be required to modify the user application source code besides recompiling it (more information can be found + in the corresponding release notes). + +.. note:: + + There is a minor API break with previous v2.x versions: ``MEMBER_INVALID`` identifier was declared using ``#define``. + In order to prevent polluting the user workspace, it has been transformed into a ``constexpr`` within + ``eprosima::fastrtps::types`` namespace. + +This release includes the following **features**: + +1. :ref:`New participant property ` to configure SHM + transport metatraffic behavior. +2. Exposed custom payload pool on DDS :ref:`DataWriter ` and + :ref:`DataReader ` declaration. + + 1. Feature example. + +3. :ref:`Processing environment variables in XML text `. +4. Dependencies + + 1. Upgrade internal type supports using latest Fast DDS-Gen release v3.0.0. + This release introduces the following features: + + 1. `Support for @optional builtin annotation `. + 2. `Support for @extensibility builtin annotation `. + + 2. Upgrade Fast CDR submodule to v2.0.0 introducing XCDR encoding version 2. + +This release includes the following **improvements**: + +1. ``fixed_string`` comparison operators. +2. Remove mutex from `TimedEventImpl` (#3745, #3760) +3. Performance improvements on intraprocess and datasharing. +4. Improve Shared Memory resilience to crashing participants. +5. Improve scripts shebang portability. +6. Use ``foonathan_memory`` to reduce allocations in SharedMemManager. + +This release includes the following **fixes**: + +1. **Fast DDS bugfixes** + 1. Fixed XMLParser null-dereference when parsing log configuration. + 2. Allow participant XML profiles with no ```` tag. + 3. Fix encapsulation format in Writer Liveliness Protocol. + 4. Fix :cpp:func:`DomainParticipant::register_remote_type` + return when negotiating type. + 5. Fix strict real-time feature when using Flow Controller feature. + 6. Fix ParameterPropertyList increment operators. + 7. Fix bad-free when receiving malformed DATA submessage. + 8. Fix asymmetric whitelist matching. + 9. Fix heap-use-after-free on XMLElementParser. + 10. Fix History remove change return statement. +2. CI fixes + 1. Fix RemoteBuiltinEndpointHonoring blackbox test. + 2. Improve repository workflows. + 3. Use `FASTRTPS_NO_LIB` on unittest root folder. + 4. Fix Windows workflow. +3. Tools + 1. Remove C++11 check in ``fastdds-discovery-server`` CLI tool. +4. Examples + 1. Fix HelloWorldDataSharing data type. +5. Documentation + 1. Doxygen typos. +6. Repository + 1. Remove 2.9.x as active branch. +7. Non Tier 1 support + 1. Fixed SHM in 32-bit architectures. + 2. Fix warning on Win32 architecture. + +.. note:: + Upgrading to version 2.12.0 **requires** to regenerate generated source from IDL files using + `Fast DDS-Gen v3.0.1 `_. + diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index adeb0e79a..51d23178d 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -111,6 +111,7 @@ fuzzer GCC GCM getter +github Github GMAC GMock @@ -203,6 +204,7 @@ quadratically readNextData reconfigurations reconnection +RecursiveTimedMutex redistributable replier repos @@ -261,6 +263,8 @@ unmatches unmatching unwakening unwakeup +updatability +updatable Valgrind vcstool wget