From 79c5d4719ed87de67d7146e9e4689a0cc674bcbd Mon Sep 17 00:00:00 2001 From: Miguel Company Date: Fri, 3 Jan 2025 12:28:16 +0100 Subject: [PATCH] Add release notes from `v3.1.1` (#1009) Signed-off-by: Miguel Company --- docs/notes/notes.rst | 2 +- .../previous_versions/supported_versions.rst | 1 + docs/notes/previous_versions/v3.1.0.rst | 4 +-- docs/notes/previous_versions/v3.1.1.rst | 34 +++++++++++++++++++ docs/notes/versions.rst | 8 ++--- 5 files changed, 42 insertions(+), 7 deletions(-) create mode 100644 docs/notes/previous_versions/v3.1.1.rst diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst index 3d1505b70..179a93570 100644 --- a/docs/notes/notes.rst +++ b/docs/notes/notes.rst @@ -5,7 +5,7 @@ Information about the release lifecycle can be found `here `_. -.. include:: previous_versions/v3.1.0.rst +.. include:: previous_versions/v3.1.1.rst .. seealso:: diff --git a/docs/notes/previous_versions/supported_versions.rst b/docs/notes/previous_versions/supported_versions.rst index 4d2bed569..015b88e77 100644 --- a/docs/notes/previous_versions/supported_versions.rst +++ b/docs/notes/previous_versions/supported_versions.rst @@ -4,6 +4,7 @@ Supported versions Version 3.1 ----------- +.. include:: v3.1.1.rst .. include:: v3.1.0.rst Version 3.0 diff --git a/docs/notes/previous_versions/v3.1.0.rst b/docs/notes/previous_versions/v3.1.0.rst index 6f22625f2..9e895d9c2 100644 --- a/docs/notes/previous_versions/v3.1.0.rst +++ b/docs/notes/previous_versions/v3.1.0.rst @@ -1,5 +1,5 @@ -`Version 3.1.0 (latest) `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +`Version 3.1.0 `_ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This minor release includes the following **features** in an ABI compatible manner: diff --git a/docs/notes/previous_versions/v3.1.1.rst b/docs/notes/previous_versions/v3.1.1.rst new file mode 100644 index 000000000..62223c15d --- /dev/null +++ b/docs/notes/previous_versions/v3.1.1.rst @@ -0,0 +1,34 @@ +`Version 3.1.1 (latest) `_ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This patch release includes the following **features** in an ABI compatible manner: + +#. New property to select preferred key agreement algorithm + +This release includes the following **fixes**: + +#. Fix reach of maximum buffers in ``asio::send_to`` +#. Fix TCP discovery server locators translation +#. Fix unique network flows with TCP transports +#. Address OSS-Fuzz` regressions in XML parsers +#. Fix ``DataReaderHistory`` regression +#. Fix destruction data-race on participant removal in intra-process +#. Several fixes in security plugins and ``SecurityManager`` +#. Fix ``cmake`` generator evaluation +#. Fix build with ``-Werror=template-id-cdtor`` +#. Fix potential deadlock between ``StatefulWriter`` and ``FlowController`` + +This release includes the following **improvements**: + +#. Update commercial support section in README +#. Rename ``RTPSParticipantImpl.h`` to ``RTPSParticipantImpl.hpp`` +#. Check if ``SHM`` transport is disabled in ``LARGE_DATA`` modes +#. Improve Blackbox TCP tests suite +#. Test examples on Windows CI +#. Regenerate types with Fast DDS Gen 4.0.3 + +.. important:: + + When upgrading to version 3.1.1 it is **highly recommended** to regenerate generated source from IDL files + using at least `Fast DDS-Gen v4.0.3 `_. + But it is advisable to regenerate them using the latest patch version of ``Fast DDS-Gen v4.0.x``. diff --git a/docs/notes/versions.rst b/docs/notes/versions.rst index 128e3526b..a228b4dcf 100644 --- a/docs/notes/versions.rst +++ b/docs/notes/versions.rst @@ -321,7 +321,7 @@ The following table shows the corresponding versions of the Fast DDS library dep * - Product - Related version * - `Fast CDR `__ - - `v2.2.5 `__ + - `v2.2.6 `__ * - `Foonathan Memory Vendor `__ - `v1.3.1 `__ * - `Asio `__ @@ -427,13 +427,13 @@ Fast DDS as the core middleware. * - Product - Related version * - `Fast DDS Gen `__ - - `v4.0.2 `__ + - `v4.0.3 `__ * - `Fast DDS Gen - IDL parser `__ - - `v4.0.2 `__ + - `v4.0.3 `__ * - `Fast DDS python `__ - `v2.1.0 `__ * - `Shapes Demo `__ - - `v3.1.0 `__ + - `v3.1.1 `__ * - `Discovery Server `__ - `v2.0.0 `__