2.7.0 (#377)

* Refs #14910. Bump version to 2.7.0 Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910. Copy current notes to previous/2.6.1 Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910. Notes for 2.7.0 Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910. Fix spelling Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910. Address reviewer's comments Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910. Address reviewer's comments Signed-off-by: Miguel Barro <miguelbarro@eprosima.com> * Refs #14910: Include aliases file and correct list rendering Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com> Co-authored-by: Eduardo Ponz <eduardoponz@eprosima.com>
eProsima · Jul 5, 2022 · f6cbe02 · f6cbe02
1 parent c68a30d
commit f6cbe02
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 26 deletions.
diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include
@@ -78,6 +78,11 @@
 .. |DataWriter::register_instance-api| replace:: :cpp:func:`register_instance()<eprosima::fastdds::dds::DataWriter::register_instance>`
 .. |DataWriter::unregister_instance-api| replace:: :cpp:func:`unregister_instance()<eprosima::fastdds::dds::DataWriter::unregister_instance>`
 .. |DataWriter::dispose-api| replace:: :cpp:func:`dispose()<eprosima::fastdds::dds::DataWriter::dispose>`
+.. |DataWriter::write_w_timestamp| replace:: :cpp:func:`DataWriter::write_w_timestamp()<eprosima::fastdds::dds::DataWriter::write_w_timestamp>`
+.. |DataWriter::register_instance_w_timestamp| replace:: :cpp:func:`DataWriter::register_instance_w_timestamp()<eprosima::fastdds::dds::DataWriter::register_instance_w_timestamp>`
+.. |DataWriter::unregister_instance_w_timestamp| replace:: :cpp:func:`DataWriter::unregister_instance_w_timestamp()<eprosima::fastdds::dds::DataWriter::unregister_instance_w_timestamp>`
+.. |DataWriter::dispose_w_timestamp| replace:: :cpp:func:`DataWriter::dispose_w_timestamp()<eprosima::fastdds::dds::DataWriter::dispose_w_timestamp>`
+
 .. |DataWriterListener-api| replace:: :cpp:class:`DataWriterListener <eprosima::fastdds::dds::DataWriterListener>`
 
 .. |DataWriterQos-api| replace:: :cpp:class:`DataWriterQos <eprosima::fastdds::dds::DataWriterQos>`
@@ -129,19 +134,20 @@
 .. |DomainParticipant::set_default_subscriber_qos-api| replace:: :cpp:func:`set_default_subscriber_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_subscriber_qos>`
 .. |DomainParticipant::set_default_topic_qos-api| replace:: :cpp:func:`set_default_topic_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_topic_qos>`
 .. |DomainParticipant::get_qos-api| replace:: :cpp:func:`get_qos()<eprosima::fastdds::dds::DomainParticipant::get_qos>`
-.. |DomainParticipant::get_publisher_qos_from_profile| replace:: :cpp::func`get_publisher_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_publisher_qos_from_profile>`
-.. |DomainParticipant::get_subscriber_qos_from_profile| replace:: :cpp::func`get_subscriber_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_subscriber_qos_from_profile>`
-.. |DomainParticipant::get_topic_qos_from_profile| replace:: :cpp::func`get_topic_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_topic_qos_from_profile>`
+.. |DomainParticipant::get_publisher_qos_from_profile| replace:: :cpp:func:`get_publisher_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_publisher_qos_from_profile>`
+.. |DomainParticipant::get_subscriber_qos_from_profile| replace:: :cpp:func:`get_subscriber_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_subscriber_qos_from_profile>`
+.. |DomainParticipant::get_topic_qos_from_profile| replace:: :cpp:func:`get_topic_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_topic_qos_from_profile>`
 .. |DomainParticipant::set_qos-api| replace:: :cpp:func:`DomainParticipant::set_qos()<eprosima::fastdds::dds::DomainParticipant::set_qos>`
 .. |DomainParticipant::delete_contained_entities-api| replace:: :cpp:func:`delete_contained_entities()<eprosima::fastdds::dds::DomainParticipant::delete_contained_entities>`
+.. |DomainParticipant::create_topic_with_profile-api| replace:: :cpp:func:`create_topic_with_profile()<eprosima::fastdds::dds::DomainParticipant::create_topic_with_profile>`
+.. |DomainParticipant::find_topic| replace:: :cpp:func:`find_topic()<eprosima::fastdds::dds::DomainParticipant::find_topic>`
 
 .. |DomainParticipantFactory-api| replace:: :cpp:class:`DomainParticipantFactory<eprosima::fastdds::dds::DomainParticipantFactory>`
 .. |DomainParticipantFactory::create_participant_with_profile-api| replace:: :cpp:func:`create_participant_with_profile()<eprosima::fastdds::dds::DomainParticipantFactory::create_participant_with_profile>`
 .. |DomainParticipantFactory::create_participant-api| replace:: :cpp:func:`create_participant()<eprosima::fastdds::dds::DomainParticipantFactory::create_participant>`
-.. |DomainParticipant::create_topic_with_profile-api| replace:: :cpp:func:`create_topic_with_profile()<eprosima::fastdds::dds::DomainParticipant::create_topic_with_profile>`
 .. |DomainParticipantFactory::delete_participant-api| replace:: :cpp:func:`delete_participant()<eprosima::fastdds::dds::DomainParticipantFactory::delete_participant>`
 .. |DomainParticipantFactory::get_default_participant_qos-api| replace:: :cpp:func:`get_default_participant_qos()<eprosima::fastdds::dds::DomainParticipantFactory::get_default_participant_qos>`
-.. |DomainParticipant::get_participant_qos_from_profile| replace:: :cpp::func`get_participant_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_participant_qos_from_profile>`
+.. |DomainParticipant::get_participant_qos_from_profile| replace:: :cpp:func:`get_participant_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_participant_qos_from_profile>`
 .. |DomainParticipantFactory::get_instance-api| replace:: :cpp:func:`get_instance()<eprosima::fastdds::dds::DomainParticipantFactory::get_instance>`
 .. |DomainParticipantFactory::load_XML_profiles_file-api| replace:: :cpp:func:`load_XML_profiles_file()<eprosima::fastdds::dds::DomainParticipantFactory::load_XML_profiles_file>`
 .. |DomainParticipantFactory::load_XML_profiles_string-api| replace:: :cpp:func:`load_XML_profiles_string()<eprosima::fastdds::dds::DomainParticipantFactory::load_XML_profiles_string>`
@@ -196,7 +202,7 @@
 .. |Publisher::create_datawriter-api| replace:: :cpp:func:`create_datawriter()<eprosima::fastdds::dds::Publisher::create_datawriter>`
 .. |Publisher::delete_datawriter-api| replace:: :cpp:func:`delete_datawriter()<eprosima::fastdds::dds::Publisher::delete_datawriter>`
 .. |Publisher::get_default_datawriter_qos-api| replace:: :cpp:func:`get_default_datawriter_qos()<eprosima::fastdds::dds::Publisher::get_default_datawriter_qos>`
-.. |Publisher::get_datawriter_qos_from_profile| replace:: :cpp::func`get_datawriter_qos_from_profile()<eprosima::fastdds::dds::Publisher::get_datawriter_qos_from_profile>`
+.. |Publisher::get_datawriter_qos_from_profile| replace:: :cpp:func:`get_datawriter_qos_from_profile()<eprosima::fastdds::dds::Publisher::get_datawriter_qos_from_profile>`
 .. |Publisher::get_qos-api| replace:: :cpp:func:`get_qos()<eprosima::fastdds::dds::Publisher::get_qos>`
 .. |Publisher::set_default_datawriter_qos-api| replace:: :cpp:func:`set_default_datawriter_qos()<eprosima::fastdds::dds::Publisher::set_default_datawriter_qos>`
 .. |Publisher::set_qos-api| replace:: :cpp:func:`Publisher::set_qos()<eprosima::fastdds::dds::Publisher::set_qos>`
@@ -218,7 +224,7 @@
 .. |Subscriber::set_qos-api| replace:: :cpp:func:`Subscriber::set_qos()<eprosima::fastdds::dds::Subscriber::set_qos>`
 .. |Subscriber::get_default_datareader_qos-api| replace:: :cpp:func:`get_default_datareader_qos()<eprosima::fastdds::dds::Subscriber::get_default_datareader_qos>`
 .. |Subscriber::set_default_datareader_qos-api| replace:: :cpp:func:`set_default_datareader_qos()<eprosima::fastdds::dds::Subscriber::set_default_datareader_qos>`
-.. |Subscriber::get_datareader_qos_from_profile| replace:: :cpp::func`get_datareader_qos_from_profile()<eprosima::fastdds::dds::Subscriber::get_datareader_qos_from_profile>`
+.. |Subscriber::get_datareader_qos_from_profile| replace:: :cpp:func:`get_datareader_qos_from_profile()<eprosima::fastdds::dds::Subscriber::get_datareader_qos_from_profile>`
 .. |Subscriber::create_datareader-api| replace:: :cpp:func:`create_datareader()<eprosima::fastdds::dds::Subscriber::create_datareader>`
 .. |Subscriber::delete_datareader-api| replace:: :cpp:func:`delete_datareader()<eprosima::fastdds::dds::Subscriber::delete_datareader>`
 .. |Subscriber::create_datareader_with_profile-api| replace:: :cpp:func:`create_datareader_with_profile()<eprosima::fastdds::dds::Subscriber::create_datareader_with_profile>`

diff --git a/docs/conf.py b/docs/conf.py
@@ -380,9 +380,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'2.6.1'
+version = u'2.7.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.6.1'
+release = u'2.7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/fastdds/api_reference/spelling_wordlist.txt b/docs/fastdds/api_reference/spelling_wordlist.txt
@@ -26,8 +26,8 @@ DataRepresentationQosPolicy
 DataSharingQosPolicy
 datawriter
 DataWriter
-datawriters
 DataWriterQos
+datawriters
 DeadlineQosPolicy
 deserialized
 destinated
@@ -50,8 +50,8 @@ eprosima
 expectsInlineQos
 fastrtps
 filteredX
-fragmentnumbers
 FlowController
+fragmentnumbers
 GenericDataQosPolicy
 getHistory
 getTypeDependencies
@@ -90,8 +90,8 @@ mutex
 myFilterFactory
 nackResponseDelay
 nackSupressionDuration
-NoOpDomainParticipantListener
 NonConstEnabler
+NoOpDomainParticipantListener
 nullptr
 Num
 OfferedDeadlineMissedStatus

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -1,27 +1,32 @@
+.. include:: ../03-exports/aliases-api.include
+
 .. _release_notes:
 
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-Version 2.6.1
+Version 2.7.0
 =============
 
 This release includes the following **improvements**:
 
-1. Support for :ref:`writer side content filtering <dds_layer_topic_contentFilteredTopic_writer_side>`
-2. Support hexadecimal values on SQL filter
-3. Support for :cpp:func:`DataWriter::get_key_value()<eprosima::fastdds::dds::DataWriter::get_key_value>`
-4. Support for :cpp:func:`DataReader::lookup_instance()<eprosima::fastdds::dds::DataReader::lookup_instance>`
-5. Support for SampleLostStatus on DataReader
-6. Improved doxygen documentation
+1. Support for :ref:`DDS SampleRejectedStatus API <dds_layer_core_status_sampleRejectedStatus>`
+2. Support for DDS DataWriter methods:
+
+  1. |DataWriter::write_w_timestamp|
+  2. |DataWriter::register_instance_w_timestamp|
+  3. |DataWriter::unregister_instance_w_timestamp|
+  4. |DataWriter::dispose_w_timestamp|
+
+3. Support for DDS |DomainParticipant::find_topic|
+4. Support for GCC 12
+5. Upgrade CMake minimum requirement to 3.16.3
+6. Add Windows DLL support to Dynamic Types API
 
 Some **bugfixes** are also included:
 
-1. Fixed several lock order inversion issues
-2. Fixed data race when closing UDP channels
-3. Fixed empty partition validation checks
-4. Fixed corner case with reliable writers and samples with a huge number of fragments
-5. Other minor fixes and improvements
+1. Deadlocks and data races
+2. Move deprecated OpenSSL cleanup function to match the right version
 
 .. note::
   If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
@@ -31,6 +36,7 @@ Some **bugfixes** are also included:
 Previous versions
 =================
 
+.. include:: previous_versions/v2.6.1.rst
 .. include:: previous_versions/v2.6.0.rst
 .. include:: previous_versions/v2.5.1.rst
 .. include:: previous_versions/v2.5.0.rst

diff --git a/docs/notes/previous_versions/v2.6.1.rst b/docs/notes/previous_versions/v2.6.1.rst
@@ -0,0 +1,24 @@
+Version 2.6.1
+=============
+
+This release includes the following **improvements**:
+
+1. Support for :ref:`writer side content filtering <dds_layer_topic_contentFilteredTopic_writer_side>`
+2. Support hexadecimal values on SQL filter
+3. Support for :cpp:func:`DataWriter::get_key_value()<eprosima::fastdds::dds::DataWriter::get_key_value>`
+4. Support for :cpp:func:`DataReader::lookup_instance()<eprosima::fastdds::dds::DataReader::lookup_instance>`
+5. Support for SampleLostStatus on DataReader
+6. Improved doxygen documentation
+
+Some **bugfixes** are also included:
+
+1. Fixed several lock order inversion issues
+2. Fixed data race when closing UDP channels
+3. Fixed empty partition validation checks
+4. Fixed corner case with reliable writers and samples with a huge number of fragments
+5. Other minor fixes and improvements
+
+.. 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
@@ -144,6 +144,7 @@ nanosec
 nupkg
 offsetd
 oneway
+OpenSSL
 optionparser
 OSS
 persistency
@@ -204,12 +205,12 @@ thirdparty
 tinyxml
 topologies
 Topologies
+txqueuelen
 typeobject
 TypeObject
-typesupport
 typeros
 typeros2
-txqueuelen
+typesupport
 uint
 uncheck
 unicast