Skip to content

Commit 4923617

Browse files
jsan-rtjsan-rt
authored
Bump to 2.10.1 and updated release notes (#476)
* Refs #17983: Bump to 2.10.1 and updated release notes Signed-off-by: Javier Santiago <[email protected]> * Refs #17983: Fixed notes and spelling Signed-off-by: Javier Santiago <[email protected]> --------- Signed-off-by: Javier Santiago <[email protected]>
1 parent d39968d commit 4923617

File tree

4 files changed

+102
-77
lines changed

4 files changed

+102
-77
lines changed

‎docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -380,9 +380,9 @@ def configure_doxyfile(
380380
# built documents.
381381
#
382382
# The short X.Y version.
383-
version = u'2.10.0'
383+
version = u'2.10.1'
384384
# The full version, including alpha/beta/rc tags.
385-
release = u'2.10.0'
385+
release = u'2.10.1'
386386

387387
# The language for content autogenerated by Sphinx. Refer to documentation
388388
# for a list of supported languages.

‎docs/notes/notes.rst

+12-75
Original file line numberDiff line numberDiff line change
@@ -5,88 +5,24 @@
55
Information about the release lifecycle can be found
66
`here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
77

8-
Version 2.10.0
8+
Version 2.10.1
99
==============
1010

11-
This minor release includes several new features, improvements and bugfixes.
11+
This release includes the following **feature** in an ABI compatible way:
1212

13-
.. note::
14-
Mind that, even though this release is API compatible with previous v2.x versions, it is *NOT* ABI compatible with
15-
previous versions.
16-
This means that applications upgrading Fast DDS to v2.10.0 will require recompilation, though not source code
17-
modification.
18-
19-
.. note::
20-
It is also advisable to regenerate the type support from the IDL files using
21-
`Fast DDS-Gen v2.4.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.4.0>`_.
22-
Furthermore, if upgrading to v2.10.0, it is also recommended to upgrade Fast CDR to
23-
`v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_.
24-
25-
This release includes the following **features**:
26-
27-
1. New :ref:`dds_layer_publisher_dataWriterListener_on_unack_sample_removed` in
28-
:cpp:class:`DataWriterListener <eprosima::fastdds::dds::DataWriterListener>`.
29-
2. :ref:`Secure Discovery Server <DS_security>`.
30-
3. DomainParticipant ignore empty API.
31-
4. RTPS :cpp:func:`ReaderListener::on_incompatible_type <eprosima::fastrtps::rtps::ReaderListener::on_incompatible_type>`
32-
and :cpp:func:`WriterListener::on_incompatible_type <eprosima::fastrtps::rtps::WriterListener::on_incompatible_type>`
33-
empty API.
13+
1. :cpp:func:`ignore_participant()<eprosima::fastdds::dds::DomainParticipant::ignore_participant>` implementation
3414

35-
This release includes the following **improvements**:
15+
This release includes the following **bugfixes**:
3616

37-
1. **Fast DDS improvements**
38-
1. Improve behavior when ``STRICT_REALTIME`` :ref:`CMake option <cmake_options>` is not enabled.
39-
2. Using functors for ``for_matched_readers`` parameter.
40-
3. Improve auto GAPs in Data Sharing.
41-
4. Use standard value for ``PID_RELATED_SAMPLE_IDENTITY``.
42-
2. **Contributions and repository quality**
43-
1. Update Pull Request template.
44-
2. Update foonathan_memory quality declaration.
45-
3. Update XSD schema.
46-
4. Make network headers private avoiding exposing non-public API.
47-
5. Improve Doxygen documentation for
48-
:cpp:class:`ResourceLimitsQosPolicy <eprosima::fastdds::dds::ResourceLimitsQosPolicy>`.
49-
3. **Examples**
50-
1. New :ref:`Request-Reply example <use-case-request-reply>`.
51-
4. **CI improvements**
52-
1. New workflow to check documentation build.
53-
2. ASAN workflow updated to use Ubuntu 22.04.
54-
5. **Dependencies**
55-
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.4.0.
56-
2. Upgrade Fast CDR submodule to v1.0.27.
57-
6. **Fast DDS CLI**
58-
1. Handle ``SIGTERM`` signal.
59-
7. **Community supported platforms**
60-
1. :ref:`QNX 7.1 build infrastructure <qnx_sources>`.
17+
1. Fix repeated matched event notification.
18+
2. Fix regression introduced by #3396.
19+
3. Initial acknack backoff.
20+
4. Fix regular expression in XML schema.
21+
5. Correctly assign multicast port to multicast initial peers.
6122

62-
This release includes the following **fixes**:
23+
This release includes the following **CI improvements**:
6324

64-
1. **Security vulnerability**
65-
1. Fix chain of trust issues with a single CA certificate.
66-
2. **Bugfixes**
67-
1. Fix RTPS StatelessWriter ACK check.
68-
2. ASAN (Address Sanitizer) fixes.
69-
3. UBSan (Undefined Behavior Sanitizer) fixes.
70-
4. Export public API correctly in Windows.
71-
5. Correctly handle builtin endpoints mask.
72-
6. Fix backwards compatibility using SHM communication.
73-
7. Protect against uncaught exception in SHM segment creation.
74-
8. Fix build for GCC 5.
75-
9. Validity check for first sequence number.
76-
10. Fix crash when enabling DisablePositiveACKsQoSPolicy with remote best-effort readers.
77-
3. **Synchronization fixes**
78-
1. Take mutex when removing local reader in WLP.
79-
2. Fix data races in SecurityManager authentication process.
80-
4. **CI fixes**
81-
1. Fix test building when using ``GTEST_INDIVIDUAL`` :ref:`CMake option <cmake_options>`.
82-
2. Fix overflow in received samples in performance tests.
83-
5. **Example fixes**
84-
1. Avoid creating entities within callbacks in DynamicHelloWorldExample.
85-
2. Remove Asio dependency from DeadlineQoSExample.
86-
6. **Repository fixes**
87-
1. Remove 2.7.x as active branch.
88-
7. **Community supported platforms**
89-
1. Include right header when building for iOS.
25+
1. Update runner and GCC version for Thread Sanitizer job.
9026

9127
.. note::
9228
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -96,6 +32,7 @@ This release includes the following **fixes**:
9632
Previous versions
9733
=================
9834

35+
.. include:: previous_versions/v2.10.0.rst
9936
.. include:: previous_versions/v2.9.1.rst
10037
.. include:: previous_versions/v2.9.0.rst
10138
.. include:: previous_versions/v2.8.1.rst

‎docs/notes/previous_versions/v2.10.0.rst

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
Version 2.10.0
2+
^^^^^^^^^^^^^^
3+
4+
This minor release includes several new features, improvements and bugfixes.
5+
6+
.. note::
7+
Mind that, even though this release is API compatible with previous v2.x versions, it is *NOT* ABI compatible with
8+
previous versions.
9+
This means that applications upgrading Fast DDS to v2.10.0 will require recompilation, though not source code
10+
modification.
11+
12+
.. note::
13+
It is also advisable to regenerate the type support from the IDL files using
14+
`Fast DDS-Gen v2.4.0 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v2.4.0>`_.
15+
Furthermore, if upgrading to v2.10.0, it is also recommended to upgrade Fast CDR to
16+
`v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_.
17+
18+
This release includes the following **features**:
19+
20+
1. New :ref:`dds_layer_publisher_dataWriterListener_on_unack_sample_removed` in
21+
:cpp:class:`DataWriterListener <eprosima::fastdds::dds::DataWriterListener>`.
22+
2. :ref:`Secure Discovery Server <DS_security>`.
23+
3. DomainParticipant ignore empty API.
24+
4. RTPS :cpp:func:`ReaderListener::on_incompatible_type <eprosima::fastrtps::rtps::ReaderListener::on_incompatible_type>`
25+
and :cpp:func:`WriterListener::on_incompatible_type <eprosima::fastrtps::rtps::WriterListener::on_incompatible_type>`
26+
empty API.
27+
28+
This release includes the following **improvements**:
29+
30+
1. **Fast DDS improvements**
31+
1. Improve behavior when ``STRICT_REALTIME`` :ref:`CMake option <cmake_options>` is not enabled.
32+
2. Using functors for ``for_matched_readers`` parameter.
33+
3. Improve auto GAPs in Data Sharing.
34+
4. Use standard value for ``PID_RELATED_SAMPLE_IDENTITY``.
35+
2. **Contributions and repository quality**
36+
1. Update Pull Request template.
37+
2. Update foonathan_memory quality declaration.
38+
3. Update XSD schema.
39+
4. Make network headers private avoiding exposing non-public API.
40+
5. Improve Doxygen documentation for
41+
:cpp:class:`ResourceLimitsQosPolicy <eprosima::fastdds::dds::ResourceLimitsQosPolicy>`.
42+
3. **Examples**
43+
1. New :ref:`Request-Reply example <use-case-request-reply>`.
44+
4. **CI improvements**
45+
1. New workflow to check documentation build.
46+
2. ASAN workflow updated to use Ubuntu 22.04.
47+
5. **Dependencies**
48+
1. Upgrade internal type supports using latest Fast DDS-Gen release v2.4.0.
49+
2. Upgrade Fast CDR submodule to v1.0.27.
50+
6. **Fast DDS CLI**
51+
1. Handle ``SIGTERM`` signal.
52+
7. **Community supported platforms**
53+
1. :ref:`QNX 7.1 build infrastructure <qnx_sources>`.
54+
55+
This release includes the following **fixes**:
56+
57+
1. **Security vulnerability**
58+
1. Fix chain of trust issues with a single CA certificate.
59+
2. **Bugfixes**
60+
1. Fix RTPS StatelessWriter ACK check.
61+
2. ASAN (Address Sanitizer) fixes.
62+
3. UBSan (Undefined Behavior Sanitizer) fixes.
63+
4. Export public API correctly in Windows.
64+
5. Correctly handle builtin endpoints mask.
65+
6. Fix backwards compatibility using SHM communication.
66+
7. Protect against uncaught exception in SHM segment creation.
67+
8. Fix build for GCC 5.
68+
9. Validity check for first sequence number.
69+
10. Fix crash when enabling DisablePositiveACKsQoSPolicy with remote best-effort readers.
70+
3. **Synchronization fixes**
71+
1. Take mutex when removing local reader in WLP.
72+
2. Fix data races in SecurityManager authentication process.
73+
4. **CI fixes**
74+
1. Fix test building when using ``GTEST_INDIVIDUAL`` :ref:`CMake option <cmake_options>`.
75+
2. Fix overflow in received samples in performance tests.
76+
5. **Example fixes**
77+
1. Avoid creating entities within callbacks in DynamicHelloWorldExample.
78+
2. Remove Asio dependency from DeadlineQoSExample.
79+
6. **Repository fixes**
80+
1. Remove 2.7.x as active branch.
81+
7. **Community supported platforms**
82+
1. Include right header when building for iOS.
83+
84+
.. note::
85+
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
86+
files using *fastddsgen*.
87+
If you are upgrading from any older version, regenerating the code is *highly recommended*.

‎docs/spelling_wordlist.txt

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ autodispose
2222
autoenable
2323
autoid
2424
automake
25+
backoff
2526
benchmarking
2627
bitfield
2728
Bitfields

0 commit comments

Comments
 (0)