Notes for 2.0.0 (#144)

* Refs #8525. Added 1.10.0 to previous versions.

* Refs #8525. Added release notes for 2.0.0

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

* Refs #8525. Fixed format errors.

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

* Refs #8525. Adding words to spell checker.

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

* Refs #8525. Add v1.8.4 release notes.

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

* Refs #8525. Fixing linters.

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

* Refs #8529. Addressing review comments.

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

docs/notes/notes.rst

@@ -1,57 +1,54 @@
-Version 1.10.0
-==============
+Version 2.0.0
+=============
 
-This release adds the following features:
+This release has the following **API breaks**:
 
-* New built-in :ref:`comm-transports-shm`
-* Transport API refactored to support locator iterators
-* Added subscriber API to retrieve info of first non-taken sample
-* Added parameters to fully avoid dynamic allocations
-* History of built-in endpoints can be configured
-* Bump to FastCDR v1.0.13.
-* Bump to Fast-RTPS-Gen v1.0.4.
-* Require CMake 3.5 but use policies from 3.13
+* eClock API, which was deprecated on v1.9.1, has been removed
+* `eprosima::fastrtps::rtps::RTPSDomain::createParticipant` methods now have an additional first argument `domain_id`
+* Data member `domainId` has been removed from `eprosima::fastrtps::rtps::RTPSParticipantAttributes` and added to
+  `eprosima::fastrtps::ParticipantAttributes`
 
-It also includes the following bug fixes and improvements:
+Users should also be aware of the following **deprecation announcement**:
+
+* All classes inside the namespace `eprosima::fastrtps` should be considered deprecated.
+  Equivalent functionality is offered through namespace `eprosima::fastdds`.
+* Namespaces beneath `eprosima::fastrtps` are not included in this deprecation, i.e.
+  `eprosima::fastrtps::rtps` can still be used)
 
-* Fixed alignment on parameter lists
-* Fixed error sending more than 256 fragments.
-* Fix handling of STRICT_REALTIME.
-* Fixed submessage_size calculation on last data_frag.
-* Solved an issue when recreating a publishing participant with the same GUID.
-* Solved an issue where a publisher could block on write for a long time when a new
-  subscriber (late joiner) is matched, if the publisher had already sent a large number
-  of messages.
-* Correctly handling the case where lifespan expires at the same time on several samples.
-* Solved some issues regarding liveliness on writers with no readers.
-* Correctly removing changes from histories on keyed topics.
-* Not reusing cache change when sample does not fit.
-* Fixed custom wait_until methods when time is in the past.
-* Several data races and ABBA locks fixed.
-* Reduced CPU and memory usage.
-* Reduced flakiness of liveliness tests.
-* Allow for more use cases on performance tests.
+This release adds the following **features**:
 
-Several bug fixes on discovery server:
+* Added support for register/unregister/dispose instance
+* Added DDS compliant API. This new API exposes all the functionality of the Publisher-Subscriber Fast RTPS API
+  adhering to the `Data Distribution Service (DDS) version 1.4 specification <https://www.omg.org/spec/DDS/1.4>`_
+* Added Security Logging Plugin (contributed by Cannonical Ltd.)
+* Bump to FastCDR v1.0.14
+
+It also includes the following bug fixes and improvements:
 
-* Fixed local host communications.
-* Correctly trimming server history.
-* Fixed backup server operation.
-* Fixed timing issues.
+* Support for OpenSSL 1.1.1d and higher
+* Support for latest versions of gtest
+* Support for FreeBSD
+* Fault tolerance improvements to Shared Memory transport
+* Fixed segfault when no network interfaces are detected
+* Correctly ignoring length of `PID_SENTINEL` on parameter list
+* Improved traffic on PDP simple mode
+* Reduced CPU and memory usage
 
 **Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
 from IDL files using *fastrtpsgen*.
 If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
 
 
 Previous versions
------------------
+=================
 
+.. include:: previous_versions/v1.10.0.rst
 .. include:: previous_versions/v1.9.4.rst
 .. include:: previous_versions/v1.9.3.rst
 .. include:: previous_versions/v1.9.2.rst
 .. include:: previous_versions/v1.9.1.rst
 .. include:: previous_versions/v1.9.0.rst
+.. include:: previous_versions/v1.8.4.rst
 .. include:: previous_versions/v1.8.3.rst
 .. include:: previous_versions/v1.8.2.rst
 .. include:: previous_versions/v1.8.1.rst

docs/notes/previous_versions/v1.10.0.rst

@@ -0,0 +1,44 @@
+Version 1.10.0
+^^^^^^^^^^^^^^
+
+This release adds the following features:
+
+* New built-in :ref:`comm-transports-shm`
+* Transport API refactored to support locator iterators
+* Added subscriber API to retrieve info of first non-taken sample
+* Added parameters to fully avoid dynamic allocations
+* History of built-in endpoints can be configured
+* Bump to FastCDR v1.0.13.
+* Bump to Fast-RTPS-Gen v1.0.4.
+* Require CMake 3.5 but use policies from 3.13
+
+It also includes the following bug fixes and improvements:
+
+* Fixed alignment on parameter lists
+* Fixed error sending more than 256 fragments.
+* Fix handling of STRICT_REALTIME.
+* Fixed submessage_size calculation on last data_frag.
+* Solved an issue when recreating a publishing participant with the same GUID.
+* Solved an issue where a publisher could block on write for a long time when a new
+  subscriber (late joiner) is matched, if the publisher had already sent a large number
+  of messages.
+* Correctly handling the case where lifespan expires at the same time on several samples.
+* Solved some issues regarding liveliness on writers with no readers.
+* Correctly removing changes from histories on keyed topics.
+* Not reusing cache change when sample does not fit.
+* Fixed custom wait_until methods when time is in the past.
+* Several data races and ABBA locks fixed.
+* Reduced CPU and memory usage.
+* Reduced flakiness of liveliness tests.
+* Allow for more use cases on performance tests.
+
+Several bug fixes on discovery server:
+
+* Fixed local host communications.
+* Correctly trimming server history.
+* Fixed backup server operation.
+* Fixed timing issues.
+
+**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
+from IDL files using *fastrtpsgen*.
+If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.

docs/notes/previous_versions/v1.8.4.rst

@@ -0,0 +1,15 @@
+Version 1.8.4
+^^^^^^^^^^^^^
+
+This release adds the following **feature**:
+
+* XML profiles for `requester` and `replier`
+
+It also has the following **important bug fixes**:
+
+* Solved an issue when recreating a publishing participant with the same GUID (either on purpose or by chance)
+* Solved an issue where a publisher could block on `write` for a long time when, after a large number of samples
+  have been sent, a new subscriber is matched.
+
+**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
+from IDL files using *fastrtpsgen*

docs/spelling_wordlist.txt

@@ -27,6 +27,7 @@ bitset
 bitsets
 boolean
 booleans
+Cannonical
 CDR
 centric
 Centric
@@ -53,6 +54,7 @@ diffie
 domainId
 doxygen
 DurabilityKind
+eClock
 endian
 eProsima
 ethernet
@@ -90,6 +92,7 @@ mutators
 nack
 Nagle
 namespace
+Namespaces
 nupkg
 offsetd
 oneway