Include Fast DDS v2.12.0 release notes (#561)

* Refs #19490: include Fast DDS v2.12.0 release notes Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #19490: update with latest Fast DDS PRs Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #19490: Fix spelling Signed-off-by: EduPonz <[email protected]> --------- Signed-off-by: JLBuenoLopez-eProsima <[email protected]> Signed-off-by: EduPonz <[email protected]> Co-authored-by: EduPonz <[email protected]>
eProsima · Sep 29, 2023 · 5bc3073 · 5bc3073
1 parent e237870
commit 5bc3073
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 10 deletions.
diff --git a/docs/fastdds/xml_configuration/making_xml_profiles.rst b/docs/fastdds/xml_configuration/making_xml_profiles.rst
@@ -126,6 +126,8 @@ XML profile. This allows the user to read and modify predefined XML profiles bef
     :end-before: //!--
     :dedent: 8
 
+.. _xml_environment_variables:
+
 Dynamic content by leveraging environment variables
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -5,29 +5,98 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-Version 2.11.2
+Version 2.12.0
 ==============
 
+.. note::
+
+  This release upgrades the following Fast DDS dependencies:
+
+  * `Fast CDR v2.0.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.0.0>`_
+  * `Fast DDS-Gen v3.0.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.0.1>`_
+
+  Please, read also the release notes of
+  `Fast DDS-Gen v3.0.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/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 <property_policies_shm_enforce_metatraffic>` to configure SHM
+   transport metatraffic behavior.
+2. Exposed custom payload pool on DDS :ref:`DataWriter <dds_layer_publisher_datawriter_with_payload_pool_creation>` and
+   :ref:`DataReader <dds_layer_subscriber_datareader_with_payload_pool_creation>` declaration.
+
+    1. Feature example.
+
+3. :ref:`Processing environment variables in XML text <xml_environment_variables>`.
+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 <optional_members>`.
+        2. `Support for @extensibility builtin annotation <extensibility>`.
+
+    2. Upgrade Fast CDR submodule to v2.0.0 introducing XCDR encoding version 2.
+
 This release includes the following **improvements**:
 
-1. Improve Shared Memory resilience to crashing participants
-2. User configuration for :ref:`Shared Memory metatraffic <property_policies_shm_enforce_metatraffic>`
-3. Performance improvements on intraprocess and data-sharing
+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. Remove Mutex from TimedEventImpl
-2. Replace uint64_t by 8 in ``alignas`` specifier
-3. Fix XMLParser null-dereference in ``parseLogConfig``
+1. **Fast DDS bugfixes**
+    1. Fixed XMLParser null-dereference when parsing log configuration.
+    2. Allow participant XML profiles with no ``<rtps>`` tag.
+    3. Fix encapsulation format in Writer Liveliness Protocol.
+    4. Fix :cpp:func:`DomainParticipant::register_remote_type<eprosima::fastdds::dds::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::
-  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*.
+  Upgrading to version 2.12.0 **requires** to regenerate generated source from IDL files using
+  `Fast DDS-Gen v3.0.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.0.1>`_.
 
 Previous versions
 =================
 
+.. include:: previous_versions/v2.11.2.rst
 .. include:: previous_versions/v2.11.1.rst
 .. include:: previous_versions/v2.11.0.rst
 .. include:: previous_versions/v2.10.2.rst

diff --git a/docs/notes/previous_versions/v2.11.2.rst b/docs/notes/previous_versions/v2.11.2.rst
@@ -0,0 +1,19 @@
+Version 2.11.2
+^^^^^^^^^^^^^^
+
+This release includes the following **improvements**:
+
+1. Improve Shared Memory resilience to crashing participants
+2. User configuration for :ref:`Shared Memory metatraffic <property_policies_shm_enforce_metatraffic>`
+3. Performance improvements on intraprocess and data-sharing
+
+This release includes the following **fixes**:
+
+1. Remove Mutex from TimedEventImpl
+2. Replace uint64_t by 8 in ``alignas`` specifier
+3. Fix XMLParser null-dereference in ``parseLogConfig``
+
+.. 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
@@ -31,6 +31,7 @@ bitmask
 bitmasks
 bitset
 bitsets
+blackbox
 BNF
 boolean
 booleans
@@ -66,6 +67,7 @@ datagrams
 datarace
 datarate
 datareaders
+datasharing
 Datasharing
 de
 deallocate