Skip to content

Commit 7eed26c

Browse files
tempatersanchez15
tempate
and
rsanchez15
committed
Release notes for 2.1.0 (#421)
* Update release notes Signed-off-by: tempate <danieldiaz@eprosima.com> * Add dependencies update table to the release notes Signed-off-by: tempate <danieldiaz@eprosima.com> * Update Fast-DDS version and pass doc tests Signed-off-by: tempate <danieldiaz@eprosima.com> * Add support to fastcdr v1 and v2 to release notes Signed-off-by: Raul Sanchez-Mateos <raul@eprosima.com> --------- Signed-off-by: tempate <danieldiaz@eprosima.com> Signed-off-by: Raul Sanchez-Mateos <raul@eprosima.com> Co-authored-by: Raul Sanchez-Mateos <raul@eprosima.com>
1 parent 7444488 commit 7eed26c

3 files changed

Lines changed: 88 additions & 57 deletions

File tree

‎docs/rst/notes/forthcoming_version.rst‎

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,7 @@
11
.. add orphan tag when new info added to this file
22
3-
.. :orphan:
3+
:orphan:
44

55
###################
66
Forthcoming Version
77
###################
8-
9-
The next release will include the following **Features**:
10-
11-
* :ref:`Forwarding Routes <user_manual_configuration_forwarding_routes>`.
12-
* :ref:`Remove Unused Entities <user_manual_configuration_remove_unused_entities>`.
13-
* :ref:`Manual Topics <user_manual_configuration_manual_topics>`.
14-
* :ref:`Max Transmission Rate <user_manual_configuration_max_tx_rate>`.
15-
* :ref:`Max Reception Rate <user_manual_configuration_max_rx_rate>`.
16-
* :ref:`Downsampling <user_manual_configuration_downsampling>`.
17-
* :ref:`Discovery Trigger <user_manual_configuration_discovery_trigger>`.
18-
* Rename the `max-depth` under the `specs` tag to `history-depth`.
19-
* Set `app_id` and `app_metadata` attributes in *eProsima DDS Router* participants.
20-
21-
The next release will include the following **Fixes**:
22-
23-
* Make :ref:`Remove Unused Entities <user_manual_configuration_remove_unused_entities>` compatible with :ref:`Built-in Topics <user_manual_configuration_builtin_topics>`.
24-
25-
The next release will include the following **Bugfixes**:
26-
27-
* Save the instance handle data for keyed topics.

‎docs/rst/notes/notes.rst‎

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,28 @@
22

33
.. _release_notes:
44

5-
.. include:: forthcoming_version.rst
5+
.. .. include:: forthcoming_version.rst
66
77
##############
8-
Version v2.0.0
8+
Version v2.1.0
99
##############
1010

11-
This release adds new **Requirements**:
11+
The next release will include the following **Features**:
1212

13-
* `DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_ project.
13+
* :ref:`Forwarding Routes <user_manual_configuration_forwarding_routes>`.
14+
* :ref:`Remove Unused Entities <user_manual_configuration_remove_unused_entities>`.
15+
* :ref:`Manual Topics <user_manual_configuration_manual_topics>`.
16+
* :ref:`Max Transmission Rate <user_manual_configuration_max_tx_rate>`.
17+
* :ref:`Max Reception Rate <user_manual_configuration_max_rx_rate>`.
18+
* :ref:`Downsampling <user_manual_configuration_downsampling>`.
19+
* :ref:`Discovery Trigger <user_manual_configuration_discovery_trigger>`.
20+
* Rename the `max-depth` under the `specs` tag to `history-depth`.
21+
* Set `app_id` and `app_metadata` attributes in *eProsima DDS Router* participants.
22+
* Support both Fast CDR v1 and v2.
1423

15-
This release has the following **Features**:
24+
The next release will include the following **Bugfixes**:
1625

17-
* Main functionality has been moved to new repository `DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_ to reuse it in other projects.
18-
* :ref:`XML Participant <user_manual_participants_xml>`
19-
* Support for `DDS Security <https://fast-dds.docs.eprosima.com/en/v2.10.1/fastdds/security/security.html>`_.
20-
21-
This release includes the following **Internal Implementation Features**:
22-
23-
* Support :ref:`Interface Whitelisting <user_manual_configuration_interface_whitelist>`.
24-
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_custom_transport_descriptors>` (UDP or Shared Memory only) for Simple Participants.
25-
* Support :ref:`Ignore Participant Flags <user_manual_configuration_ignore_participant_flags>` for Simple Participants.
26-
* Add tests for Dynamic Types to ROS 2.
27-
* New ``CommonParticipant`` class for a Fast DDS Participant wrapper.
28-
* New ``XmlParticipant`` class for a Fast DDS Participant in which the participant is created following a profile name loaded by XML configuration.
29-
* New ``CommonReader`` class for a Fast DDS Data Reader wrapper.
30-
* New ``SimpleReader`` class for a Fast DDS Data Reader that implements abstract ``CommonReader``.
31-
* New ``SpecificQoSReader`` class for a Fast DDS Data Reader with specific QoS policies.
32-
* New ``CommonWriter`` class for a Fast DDS Data Writer wrapper.
33-
* New ``SimpleWriter`` class for a Fast DDS Data Writer that implements abstract ``CommonWriter``.
34-
* New ``QoSSpecificWriter`` class for a Fast DDS Data Writer with specific QoS policies.
35-
* New ``MultiWriter`` class for a Fast DDS Data Writer collection that contains multiple ``QoSSpecificWriter``.
36-
37-
This release includes the following **Bugfixes**:
38-
39-
* Add TSAN fixes.
40-
* Include missing DLLs.
41-
* Resolve Windows warnings.
42-
* Restore default DomainParticipantQoS after creating and enabling ``DynTypesParticipant``.
26+
* Save the instance handle data for keyed topics.
4327

4428
This release includes the following **Dependencies Update**:
4529

@@ -52,29 +36,30 @@ This release includes the following **Dependencies Update**:
5236
- New Version
5337
* - Foonathan Memory Vendor
5438
- `eProsima/foonathan_memory_vendor <https://github.com/eProsima/foonathan_memory_vendor>`_
55-
- `v1.3.0 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.0>`_
39+
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
5640
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
5741
* - Fast CDR
5842
- `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
59-
- `v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_
6043
- `v1.1.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.1.0>`_
44+
- `v2.1.2 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.2>`_
6145
* - Fast DDS
6246
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
63-
- `v2.10.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.10.1>`_
6447
- `v2.11.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.11.0>`_
48+
- `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
6549
* - Dev Utils
6650
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
67-
- `v0.3.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.3.0>`_
6851
- `v0.4.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.4.0>`_
52+
- `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
6953
* - DDS Pipe
7054
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
71-
- `v0.1.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.1.0>`_
7255
- `v0.2.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.2.0>`_
56+
- `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`__
7357

7458
#################
7559
Previous Versions
7660
#################
7761

62+
.. include:: previous_versions/v2.0.0.rst
7863
.. include:: previous_versions/v1.2.0.rst
7964
.. include:: previous_versions/v1.1.0.rst
8065
.. include:: previous_versions/v1.0.0.rst

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
2+
Version v2.0.0
3+
==============
4+
5+
This release adds new **Requirements**:
6+
7+
* `DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_ project.
8+
9+
This release has the following **Features**:
10+
11+
* Main functionality has been moved to new repository `DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_ to reuse it in other projects.
12+
* :ref:`XML Participant <user_manual_participants_xml>`
13+
* Support for `DDS Security <https://fast-dds.docs.eprosima.com/en/v2.10.1/fastdds/security/security.html>`_.
14+
15+
This release includes the following **Internal Implementation Features**:
16+
17+
* Support :ref:`Interface Whitelisting <user_manual_configuration_interface_whitelist>`.
18+
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_custom_transport_descriptors>` (UDP or Shared Memory only) for Simple Participants.
19+
* Support :ref:`Ignore Participant Flags <user_manual_configuration_ignore_participant_flags>` for Simple Participants.
20+
* Add tests for Dynamic Types to ROS 2.
21+
* New ``CommonParticipant`` class for a Fast DDS Participant wrapper.
22+
* New ``XmlParticipant`` class for a Fast DDS Participant in which the participant is created following a profile name loaded by XML configuration.
23+
* New ``CommonReader`` class for a Fast DDS Data Reader wrapper.
24+
* New ``SimpleReader`` class for a Fast DDS Data Reader that implements abstract ``CommonReader``.
25+
* New ``SpecificQoSReader`` class for a Fast DDS Data Reader with specific QoS policies.
26+
* New ``CommonWriter`` class for a Fast DDS Data Writer wrapper.
27+
* New ``SimpleWriter`` class for a Fast DDS Data Writer that implements abstract ``CommonWriter``.
28+
* New ``QoSSpecificWriter`` class for a Fast DDS Data Writer with specific QoS policies.
29+
* New ``MultiWriter`` class for a Fast DDS Data Writer collection that contains multiple ``QoSSpecificWriter``.
30+
31+
This release includes the following **Bugfixes**:
32+
33+
* Add TSAN fixes.
34+
* Include missing DLLs.
35+
* Resolve Windows warnings.
36+
* Restore default DomainParticipantQoS after creating and enabling ``DynTypesParticipant``.
37+
38+
This release includes the following **Dependencies Update**:
39+
40+
.. list-table::
41+
:header-rows: 1
42+
43+
* -
44+
- Repository
45+
- Old Version
46+
- New Version
47+
* - Foonathan Memory Vendor
48+
- `eProsima/foonathan_memory_vendor <https://github.com/eProsima/foonathan_memory_vendor>`_
49+
- `v1.3.0 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.0>`_
50+
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
51+
* - Fast CDR
52+
- `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
53+
- `v1.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_
54+
- `v1.1.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.1.0>`_
55+
* - Fast DDS
56+
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
57+
- `v2.10.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.10.1>`_
58+
- `v2.11.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.11.0>`_
59+
* - Dev Utils
60+
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
61+
- `v0.3.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.3.0>`_
62+
- `v0.4.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.4.0>`_
63+
* - DDS Pipe
64+
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
65+
- `v0.1.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.1.0>`_
66+
- `v0.2.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.2.0>`_

0 commit comments

Comments
 (0)