v2.1.0 release notes (#210)

* v2.1.0 release notes

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

* Apply suggestions

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

docs/notes/notes.rst

@@ -1,28 +1,68 @@
 .. _release_notes:
 
-Version 2.0.2
+Version 2.1.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:
+
+* 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.
+
+Users of the RTPS low-level API should also be aware of the following **API deprecations**:
+
+* History::reserve_Cache has been deprecated
+
+  * Methods RTPSWriter::new_change or RTPSReader::reserveCache should be used instead
+
+* History::release_Cache has been deprecated
+
+  * Methods RTPSWriter::release_change or RTPSReader::releaseCache should be used instead
+
+This release adds the following **features**:
 
 * Support persistence for large data
-* Improve QNX support
-* Security improvements
-* Fast DDS Quality Declaration (QL 2)
-* Large traffic reduction when using Discovery Server (up to 85-90% for large deployments)
-* Configuration of Clients of Discovery Server using an environment variable
-* A CLI for Fast DDS:
+* Added support for `on_requested_incompatible_qos` and `on_offered_incompatible_qos`
+* SKIP_DEFAULT_XML environment variable
+* Added FORCE value to THIRDPARTY cmake options
+* New log consumer (StdOutErrConsumer)
+* Added methods to get qos defined in XML Profile
+* Support for persistence on TRANSIENT_LOCAL
+
+It also includes the following **improvements**:
+
+* Internal refactor for intra-process performance boost
+* Allow usage of foonathan/memory library built without debug tool
+* Large data support on performance tests
+* Reduced flakiness of several tests
+
+Some important **bugfixes** are also included:
 
-  * This can be used to launch a discovery server
-  * Clean SHM directories with one command
+* Fixed behavior of several DDS API methods
+* Fixed interoperability issues with RTI connext
+* Fixed DLL export of some methods
+* Avoid redefinition of compiler defined macros
+* Fixed some intra-process related segmentation faults and deadlocks
+* Fixed large data payload protection issues on intra-process
+* Fixed C++17 and VS 2019 warnings
+* Fixed linker problems on some platforms
+* Fixed transient local retransmission after participant drop
+* Fixed assertion failure on persistent writers
 
-* Shared memory transport enabled by default
-* Solved edge-case interoperability issue with CycloneDDS
-* Add package.xml
+.. 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/v2.0.2.rst
 .. include:: previous_versions/v2.0.1.rst
 .. include:: previous_versions/v2.0.0.rst
 .. include:: previous_versions/v1.10.0.rst

docs/notes/previous_versions/v2.0.2.rst

@@ -0,0 +1,23 @@
+Version 2.0.2
+^^^^^^^^^^^^^
+
+This release includes the following improvements:
+
+* Improve QNX support
+* Security improvements
+* Fast DDS Quality Declaration (QL 2)
+* Large traffic reduction when using Discovery Server (up to 85-90% for large deployments)
+* Configuration of Clients of Discovery Server using an environment variable
+* A CLI for Fast DDS:
+
+  * This can be used to launch a discovery server
+  * Clean SHM directories with one command
+
+* Shared memory transport enabled by default
+* Solved edge-case interoperability issue with CycloneDDS
+* Add package.xml
+
+.. 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/spelling_wordlist.txt

@@ -35,11 +35,13 @@ Centric
 cerr
 chocolatey
 ciphertext
+cmake
 CMake
 colcon
 Colcon
-connectionless
 config
+connectionless
+connext
 cout
 coverity
 crl
@@ -71,6 +73,7 @@ extensibility
 fastcdr
 fastdds
 fastrtpsgen
+foonathan
 GCM
 getter
 Github
@@ -88,6 +91,7 @@ ifaddrs
 ignoreParticipantFlags
 initializations
 interoperability
+intra
 Intra
 IPv
 kB
@@ -141,11 +145,11 @@ runtime
 sanitizers
 scalability
 scalable
-simpleEDP
 seqNum
 SequenceNumber
 sequencenumbers
 shm
+simpleEDP
 sqlite
 stateful
 stderr