2.5.0 (#315)

* Refs 13336. Bump version.

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

* Refs 13336. Notes for 2.5.0.

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

* Refs 13261: Add links

Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com>

Co-authored-by: Eduardo Ponz <eduardoponz@eprosima.com>

docs/conf.py

@@ -297,9 +297,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.4.1'
+version = u'2.5.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.4.1'
+release = u'2.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/fastdds/transport/transport_api.rst

@@ -190,6 +190,7 @@ However, :class:`IPLocator` allows to manage them if needed.
     :end-before: //!--
     :dedent: 8
 
+.. _transport_transportApi_chaining:
 
 Chaining of transports
 ----------------------

docs/notes/notes.rst

@@ -1,36 +1,49 @@
 .. _release_notes:
 
-Version 2.4.1
+Version 2.5.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. Fixed several flaky tests
-2. Improved bandwidth usage of GAPs and HEARTBEATs
-3. Correctly implement delete_contained_entities
-4. Use native inter-process on Windows
-5. Improved performance of unregister_instance
-6. Improved OSS-fuzz integration
-7. Support for partitions on DataWriterQoS and DataReaderQoS
+* 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.
+
+* 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:`Support for PKCS#11 <pkcs11-support>` format URIs for private keys
+2. Added interfaces for content filter APIs
+3. Allow new :ref:`network interfaces to be detected at runtime <dynamic-network-interfaces>`
+4. New API on :ref:`DataWriter <api_pim_datawriter>` to wait for a specific instance to be acknowledged
+5. Added interfaces for :ref:`concatenation of transports <transport_transportApi_chaining>`
+6. Allow :ref:`XML profiles to be loaded from a string <loadingapplyingprofiles>`
+7. Allow :ref:`disabling piggyback heartbeat <xml_disableheartbeatpiggyback>` on XML and DataWriter QoS
+8. New basic configuration example
+
+It also includes the following **improvements**:
+
+1. Working implementation of instance_state and view_state
+2. Allow zero-valued keys
+3. Made some type aliases public to ease python bindings integration
+4. Improved performance by avoiding unnecessary payload copies for samples that are going to be rejected
+5. Removed unnecessary headers from Log module public headers
+6. Add support for Key annotation in TypeObjectFactory
+7. Only export public symbols on non-windows platforms
 8. Some documentation improvements
-9. Removed unused macro to avoid naming clashes
 
-This release includes the following **bugfixes**:
+Some important **bugfixes** are also included:
 
-1. Avoid bad_node_size exception when cross building
-2. Fixed build on old compilers
-3. Fixed buffers exhaustion when compiled with statistics
-4. Fixed runtime addition of Discovery Servers
-5. Fixed dangling sample references with big data
-6. Fixed history record issues with persistence
-7. Correctly disable DataReader on destruction
-8. Fixed alignment issues on XTypes QoS policies serialization
-9. Fixed reconnection to Discovery Server
-10. Correctly use builtin publisher for statistics DataWriters
-11. Fixed various GCC-11 warnings
-12. Use only public APIs from foonathan::memory
-13. Fixed installation directories for DDS examples
-14. Fixed read after free on security code
+1. Fixed payload pool handling on EDPSimple destructor
+2. Fixed null dereference on XML parser
+3. Correctly export XTypes related methods on Windows
+4. Ensure correct boost singleton destruction order
+5. Avoid warning when environment file filename is empty
+6. Correctly set GUID of DataWriter and DataReader upon creation
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -40,6 +53,7 @@ This release includes the following **bugfixes**:
 Previous versions
 =================
 
+.. include:: previous_versions/v2.4.1.rst
 .. include:: previous_versions/v2.4.0.rst
 .. include:: previous_versions/v2.3.4.rst
 .. include:: previous_versions/v2.3.3.rst

docs/notes/previous_versions/v2.4.1.rst

@@ -0,0 +1,37 @@
+Version 2.4.1
+^^^^^^^^^^^^^
+
+This release includes the following **improvements**:
+
+1. Fixed several flaky tests
+2. Improved bandwidth usage of GAPs and HEARTBEATs
+3. Correctly implement delete_contained_entities
+4. Use native inter-process on Windows
+5. Improved performance of unregister_instance
+6. Improved OSS-fuzz integration
+7. Support for partitions on DataWriterQoS and DataReaderQoS
+8. Some documentation improvements
+9. Removed unused macro to avoid naming clashes
+
+This release includes the following **bugfixes**:
+
+1. Avoid bad_node_size exception when cross building
+2. Fixed build on old compilers
+3. Fixed buffers exhaustion when compiled with statistics
+4. Fixed runtime addition of Discovery Servers
+5. Fixed dangling sample references with big data
+6. Fixed history record issues with persistence
+7. Correctly disable DataReader on destruction
+8. Fixed alignment issues on XTypes QoS policies serialization
+9. Fixed reconnection to Discovery Server
+10. Correctly use builtin publisher for statistics DataWriters
+11. Fixed various GCC-11 warnings
+12. Use only public APIs from foonathan::memory
+13. Fixed installation directories for DDS examples
+14. Fixed read after free on security code
+
+.. 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*.
+

docs/spelling_wordlist.txt

@@ -60,6 +60,7 @@ deallocation
 decrypt
 decrypted
 dependant
+dereference
 deserialization
 deserialize
 deserialized
@@ -104,8 +105,8 @@ Intra
 IPv
 kB
 latencies
-libs
 Libp
+libs
 lifecycle
 localhost
 LogTopic
@@ -128,8 +129,8 @@ nackfrag
 Nackfrag
 Nagle
 namespace
-Namespaces
 namespaces
+Namespaces
 nanosec
 nupkg
 offsetd
@@ -200,8 +201,8 @@ univocally
 unmatch
 unmatches
 unmatching
-unwakeup
 unwakening
+unwakeup
 Valgrind
 vcstool
 wget