OpenDDS Release 3.25.0

.mailmap

@@ -1,14 +1,16 @@
 # This is used by gitrelease.pl to correct commit individual author info for
-# the generation of the AUTHORS file
+# the generation of the AUTHORS file. This also corrects it in the rest of the
+# history like `git log`.
 #
 # See https://git-scm.com/docs/gitmailmap for how this works
 #
 # To fix GitHub noreply email addresses, match the real name and email to
 # what's printed by:
 #   git shortlog --summary --numbered --email
 
-Justin Wilson <wilsonj@objectcomputing.com> <jrw972@gmail.com>
-Justin Wilson <wilsonj@objectcomputing.com> Justin R. Wilson
+Justin Wilson <wilsonj@unityfoundation.io> <jrw972@gmail.com>
+Justin Wilson <wilsonj@unityfoundation.io> Justin R. Wilson
+Justin Wilson <wilsonj@unityfoundation.io> <wilsonj@objectcomputing.com>
 
 Jeff Schmitz <schmitzj@ociweb.com> <jeffrey.j.schmitz@gmail.com>
 Jeff Schmitz <schmitzj@ociweb.com> iamtheschmitzer <schmitzj@ociweb.com>
@@ -19,8 +21,9 @@ Paul Calabrese <calabrep@objectcomputing.com> <calabrese_p@ociweb.com>
 
 Huang-Ming Huang <huangh@ociweb.com> <huangming.huang@gmail.com>
 
-Fred Hornsey <hornseyf@objectcomputing.com> <fred@hornsey.us>
-Fred Hornsey <hornseyf@objectcomputing.com> Frederick Hornsey
+Fred Hornsey <hornseyf@unityfoundation.io> <fred@hornsey.us>
+Fred Hornsey <hornseyf@unityfoundation.io> Frederick Hornsey
+Fred Hornsey <hornseyf@unityfoundation.io> <hornseyf@objectcomputing.com>
 
 Doug Lewis <lewisdo@objectcomputing.com> unknown <lewisdo@objectcomputing.com>
 
@@ -50,3 +53,8 @@ Tim Pollock <pollockt@objectcomputing.com> pollocktoci <70289169+pollocktoci@use
 
 <mesnierp@objectcomputing.com> <mesnier_p@ociweb.com>
 Phil Mesnier <mesnierp@objectcomputing.com> Phil <mesnierp@objectcomputing.com>
+
+Jose Morato <jmmorato@enxarxats.com> jmmorato
+Jose Morato <jmmorato@enxarxats.com> jmorato
+Jose Morato <jmmorato@enxarxats.com> jose_morato
+Jose Morato <jmmorato@enxarxats.com> <jose.morato@swisstiming.com>

AUTHORS

@@ -24,14 +24,13 @@ Weiqi Gao <gaow@ociweb.com>
 Leif Gruenwoldt <leifer@gmail.com>
 Byron Harris <harris_b@ociweb.com>
 Scott Harris <harris_s@ociweb.com>
-Fred Hornsey <hornseyf@objectcomputing.com>
+Fred Hornsey <hornseyf@unityfoundation.io>
 Huang-Ming Huang <huangh@objectcomputing.com>
 Don Hudson <hudsond@ociweb.com>
 Martin Hünermund <xaedes@gmail.com>
 jardiamj <https://github.com/jardiamj>
 jatruong <jatruong@uw.edu>
 Iliyan Jeliazkov <iliyan@ociweb.com>
-jmmorato <jmmorato@enxarxats.com>
 Ciju John <johnc@ociweb.com>
 Brian Johnson <johnsonb@ociweb.com>
 Chip Jones <jonesc@objectcomputing.com>
@@ -49,7 +48,7 @@ Mason McParlane <mcparlanem@objectcomputing.com>
 Simon McQueen <simon.mcqueen@gmail.com>
 Phil Mesnier <mesnierp@objectcomputing.com>
 Adam Mitz <mitza@objectcomputing.com>
-Jose Morato <jose.morato@swisstiming.com>
+Jose Morato <jmmorato@enxarxats.com>
 Mouse <https://github.com/mouse07410>
 Marc Neeley <neeleym@objectcomputing.com>
 Peter Oschwald <oschwaldp@objectcomputing.com>
@@ -72,7 +71,7 @@ Steve Totten <tottens@ociweb.com>
 Dean Wette <wette_d@ociweb.com>
 Johnny Willemsen <johnny@jwillemsen.nl>
 Gary Wilson <wilsong@objectcomputing.com>
-Justin Wilson <wilsonj@objectcomputing.com>
+Justin Wilson <wilsonj@ociweb.com>
 Friedhelm Wolf <fwolf@dre.vanderbilt.edu>
 x_allaume <xavier.allaume@neoliant.com>
 xieshuaix <xieshuaix@gmail.com>

NEWS.md

@@ -1,5 +1,84 @@
 # OpenDDS Releases
 
+## Version 3.25.0 of OpenDDS
+
+Released 2023-07-20
+
+Download [this release on GitHub](https://github.com/OpenDDS/OpenDDS/releases/tag/DDS-3.25).
+
+Read [the documenation for this release on Read the Docs](https://opendds.readthedocs.io/en/dds-3.25).
+
+### Additions
+
+* The Observer interface now has support for dispose and unregister. ([PR #4137](https://github.com/OpenDDS/OpenDDS/pull/4137))
+* OpenDDS now stores configuration information in a key-value store. ([PR #4138](https://github.com/OpenDDS/OpenDDS/pull/4138), [PR #4134](https://github.com/OpenDDS/OpenDDS/pull/4134), [PR #4151](https://github.com/OpenDDS/OpenDDS/pull/4151))
+    * Configuration values can be set via API, config file, or command line.
+
+        * Currently applies to the common section and common transport configuration.
+
+* Added `encode_to_string`, `encode_to_bytes`, `decode_from_string`, and `decode_from_bytes` to `TypeSupport`. ([PR #4144](https://github.com/OpenDDS/OpenDDS/pull/4144), [PR #4122](https://github.com/OpenDDS/OpenDDS/pull/4122), [PR #4133](https://github.com/OpenDDS/OpenDDS/pull/4133), [PR #4135](https://github.com/OpenDDS/OpenDDS/pull/4135))
+    * These methods convert samples to and from other formats.
+    * Currently only `OpenDDS::DCPS::JSON_DATA_REPRESENTATION` is supported.
+
+* Add `-Gequality` option to opendds_idl to generate `==` and `!=` for structs and unions. ([PR #4154](https://github.com/OpenDDS/OpenDDS/pull/4154))
+    * The members of the struct or union must have a type that could appear in a DDS topic and be supported by opendds_idl.
+    * The motivation for this change was to make the generated code more useful as many users go on to define these operators.
+
+* CMake Config Package
+
+    * Added [executable targets](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#cmake-executables). ([PR #4160](https://github.com/OpenDDS/OpenDDS/pull/4160))
+    * [`OPENDDS_CMAKE_VERBOSE`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#var-OPENDDS_CMAKE_VERBOSE) output has been expanded, but now accepts a list of categories to control how much is logged. ([PR #4160](https://github.com/OpenDDS/OpenDDS/pull/4160))
+    * Added [`opendds_export_header`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-opendds_export_header) to generate an export header. ([PR #4160](https://github.com/OpenDDS/OpenDDS/pull/4160))
+    * [`opendds_target_sources`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-opendds_target_sources):
+        * Added [`opendds_target_sources(GENERATE_SERVER_SKELETONS)`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-arg-opendds_target_sources-GENERATE_SERVER_SKELETONS) to allow `tao_idl` to generate code for CORBA servers. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+        * Added [`opendds_target_sources(AUTO_LINK)`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-arg-opendds_target_sources-AUTO_LINK) as a fine-grained version of [`OPENDDS_AUTO_LINK_DCPS`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#var-OPENDDS_AUTO_LINK_DCPS). ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+        * Added [`opendds_target_sources(SKIP_TAO_IDL)`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-arg-opendds_target_sources-SKIP_TAO_IDL) to disable `tao_idl`. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+        * Added [`opendds_target_sources(SKIP_OPENDDS_IDL)`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-arg-opendds_target_sources-SKIP_OPENDDS_IDL) to disable `opendds_idl`. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+        * Added [`opendds_target_sources(USE_EXPORT)`](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#func-arg-opendds_target_sources-USE_EXPORT) to allow overriding the generated export header with an existing one. ([PR #4160](https://github.com/OpenDDS/OpenDDS/pull/4160))
+
+    * Libraries and features can be passed to `find_package(OpenDDS COMPONENTS)` to change what is required. ([PR #4160](https://github.com/OpenDDS/OpenDDS/pull/4160), [PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+
+        * See [Components](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html#cmake-components) for details.
+
+### Security
+
+* Fixed null pointer exception caused by RTPS Parameters with incorrect zero size. ([PR #4197](https://github.com/OpenDDS/OpenDDS/pull/4197))
+
+### Fixes
+
+* CMake Config Package
+    * Made linking dependencies and macro definitions closer match using MPC with OpenDDS and TAO. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+    * Fixed issues with passing `OPENDDS_IDL_OPTIONS -SI` to `opendds_target_sources`. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+
+* Fixed issue deserializing bounded sequences with JSON ([PR #4150](https://github.com/OpenDDS/OpenDDS/pull/4150))
+    * The deserialization will fail if the JSON input contains more elements than the bounded sequence can hold.
+
+* Updated the RtpsRelay’s tracking of client IP addresses so they are removed when no longer used. ([PR #4202](https://github.com/OpenDDS/OpenDDS/pull/4202))
+
+    * The RtpsRelay configuration option -MaxAddrSetSize was renamed to -MaxIpsPerClient
+
+### Documentation
+
+* Moved various markdown files into the Sphinx documentation so that they are now included along with the Developer’s Guide: ([PR #4139](https://github.com/OpenDDS/OpenDDS/pull/4139))
+    * `INSTALL.md` is now [Building and Installing](https://opendds.readthedocs.io/en/dds-3.25/building/index.html).
+    * `docs/dependencies.md` is now [Dependencies](https://opendds.readthedocs.io/en/dds-3.25/building/dependencies.html).
+    * `docs/cmake.md` is now [Using OpenDDS in a CMake Project](https://opendds.readthedocs.io/en/dds-3.25/building/cmake.html).
+    * `docs/android.md` is now [Android](https://opendds.readthedocs.io/en/dds-3.25/building/android.html).
+    * `docs/ios.md` is now [iOS](https://opendds.readthedocs.io/en/dds-3.25/building/ios.html).
+
+* Restructured how the documentation is presented to cleanly separate the Developer’s Guide and internal documentation. ([PR #4139](https://github.com/OpenDDS/OpenDDS/pull/4139))
+* Added a [proper main page](https://opendds.readthedocs.io/en/dds-3.25/index.html). ([PR #4139](https://github.com/OpenDDS/OpenDDS/pull/4139))
+* Added [Glossary](https://opendds.readthedocs.io/en/dds-3.25/glossary.html). ([PR #4139](https://github.com/OpenDDS/OpenDDS/pull/4139))
+* In addition to [`NEWS.md`](https://github.com/OpenDDS/OpenDDS/blob/DDS-3.25/NEWS.md), started adding release notes to [Release Notes](https://opendds.readthedocs.io/en/dds-3.25/news.html). ([PR #4125](https://github.com/OpenDDS/OpenDDS/pull/4125))
+
+### Notes
+
+* CMake Config Package
+
+    * `OPENDDS_TARGET_SOURCES` is now called `opendds_target_sources`. ([PR #4140](https://github.com/OpenDDS/OpenDDS/pull/4140))
+
+        * CMake macros and functions names are case insensitive, so this should have no effect on CMake code.
+
 ## Version 3.24.2 of OpenDDS
 OpenDDS 3.24.2 was released on Jun 30 2023.
 

PROBLEM-REPORT-FORM

@@ -1,6 +1,6 @@
-This is OpenDDS version 3.25.0-dev (NOT A RELEASE)
+This is OpenDDS version 3.25.0, released Jul 20 2023
 
-    OpenDDS VERSION: 3.25.0-dev
+    OpenDDS VERSION: 3.25.0
     TAO VERSION:
 
     HOST MACHINE and OPERATING SYSTEM:

README.md

@@ -9,8 +9,8 @@ These standards define a set of interfaces and protocols for developing distribu
 Although OpenDDS is itself developed in C++, Java bindings are provided so that Java applications can use OpenDDS.
 OpenDDS also includes support for the DDS Security and XTypes specifications.
 
-OpenDDS is built on the [ACE](https://opendds.readthedocs.io/en/master/building/dependencies.html#ace-tao) abstraction layer to provide platform portability.
-OpenDDS also leverages the capabilities of [TAO](https://opendds.readthedocs.io/en/master/building/dependencies.html#ace-tao) for IDL compilation and the OpenDDS [DCPS Information Repository](https://opendds.readthedocs.io/en/master/devguide/the_dcps_information_repository.html).
+OpenDDS is built on the [ACE](https://opendds.readthedocs.io/en/dds-3.25/building/dependencies.html#ace-tao) abstraction layer to provide platform portability.
+OpenDDS also leverages the capabilities of [TAO](https://opendds.readthedocs.io/en/dds-3.25/building/dependencies.html#ace-tao) for IDL compilation and the OpenDDS [DCPS Information Repository](https://opendds.readthedocs.io/en/latest-release/devguide/the_dcps_information_repository.html).
 
 The primary development of OpenDDS was done by
 [Object Computing, Incorporated](http://www.objectcomputing.com) in
@@ -35,7 +35,7 @@ details.
 
 ## Documentation
 
-- The OpenDDS Developer's Guide is available at https://opendds.readthedocs.io/.
+- The OpenDDS Developer's Guide is available at https://opendds.readthedocs.io/en/dds-3.25.
 
 - For developers wanting to contribute to OpenDDS, please read [the development guidelines](https://opendds.readthedocs.io/en/master/internal/dev_guidelines.html).
 
@@ -83,7 +83,7 @@ formal/2019-04-03 (version 2.3)](https://www.omg.org/spec/DDSI-RTPS/2.3).  See
 the OpenDDS Developer's Guide and the file [docs/design/RTPS](docs/design/RTPS)
 for more details on RTPS.
 
-See the [Developer's Guide](https://opendds.readthedocs.io/en/latest-release/building/introduction.html) for
+See the [Developer's Guide](https://opendds.readthedocs.io/en/dds-3.25/building/introduction.html) for
 information on OpenDDS compliance with the DDS specification. If you would like
 to contribute a feature or sponsor the developers to add a feature please see
 the Support section above for contact information.
@@ -92,7 +92,7 @@ the Support section above for contact information.
 
 These are just the required dependencies. For a complete detailed list of
 dependencies, including optional ones, see
-https://opendds.readthedocs.io/en/master/building/dependencies.html.
+https://opendds.readthedocs.io/en/dds-3.25/building/dependencies.html.
 
 ### ACE/TAO
 
@@ -134,7 +134,7 @@ Embedded/Mobile/IoT:
 * LynxOS-178 (OpenDDS Safety Profile)
 * VxWorks 6.9, 7, 21.03 (see below)
 * [Linux on Raspberry Pi](https://opendds.org/quickstart/GettingStartedPi.html)
-* [Android 9.0 "Pie" (API Level 28) NDK r18b](https://opendds.readthedocs.io/en/latest-release/building/android.html)
+* [Android 9.0 "Pie" (API Level 28) NDK r18b](https://opendds.readthedocs.io/en/dds-3.25/building/android.html)
 
 We have built OpenDDS for VxWorks 6.9, 7, and 21.03 and have run basic
 system and performance tests (but not the entire regression test suite).
@@ -164,7 +164,7 @@ This release of OpenDDS has been tested using the following compilers:
 ## Building and Installing
 
 For building and installation instructions see
-https://opendds.readthedocs.io/en/latest-release/building/index.html
+https://opendds.readthedocs.io/en/dds-3.25/building/index.html
 
 ## Quick Start with Docker
 

VERSION.txt

@@ -1,4 +1,4 @@
-This is OpenDDS version 3.25.0-dev (NOT A RELEASE)
+This is OpenDDS version 3.25.0, released Jul 20 2023
 
 This software is open source and free of licensing fees.  See the
 LICENSE file (in this directory) for license details.

dds/Version.h

@@ -11,9 +11,9 @@
 #define OPENDDS_MAJOR_VERSION 3
 #define OPENDDS_MINOR_VERSION 25
 #define OPENDDS_MICRO_VERSION 0
-#define OPENDDS_VERSION_METADATA "dev"
-#define OPENDDS_IS_RELEASE 0
-#define OPENDDS_VERSION "3.25.0-dev"
+#define OPENDDS_VERSION_METADATA ""
+#define OPENDDS_IS_RELEASE 1
+#define OPENDDS_VERSION "3.25.0"
 
 #define OPENDDS_VERSION_AT_LEAST(MAJOR, MINOR, MICRO) (\
   (OPENDDS_MAJOR_VERSION > (MAJOR)) || \