From f2f2630d7905ccff4d591909ea1e68a0d8bf34e0 Mon Sep 17 00:00:00 2001 From: Fred Hornsey Date: Tue, 30 Apr 2024 12:58:46 -0500 Subject: [PATCH] Fix Minor Issues in DevGuide --- docs/devguide/introduction.rst | 6 +++--- docs/devguide/run_time_configuration.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/devguide/introduction.rst b/docs/devguide/introduction.rst index 1260260e023..891719a745a 100644 --- a/docs/devguide/introduction.rst +++ b/docs/devguide/introduction.rst @@ -36,7 +36,7 @@ You may modify it for your own needs, within the terms of the license agreements You must not copyright OpenDDS software. For details of the licensing terms, see the file named :ghfile:`LICENSE` that is included in the OpenDDS source code distribution or visit https://opendds.org/about/license.html. -OpenDDS also utilizes other open source software products including MPC (Make Project Creator), ACE (the ADAPTIVE Communication Environment), and TAO (The ACE ORB). +OpenDDS also utilizes other open source software products including :ref:`deps-mpc` and :ref:`deps-ace-tao`. OpenDDS is open source and the development team welcomes contributions of code, tests, documentation, and ideas. Active participation by users ensures a robust implementation. @@ -741,7 +741,7 @@ In Static Discovery, each participant starts with a database containing identifi When an application creates a data writer or data reader, Static Discovery causes it to send out periodic announcements. Upon receiving one of these announcements, Static Discovery consults its local database of entities to look up the details necessary for matching and matches it against local entities. -Static Discovery requires that the :ref:`quality_of_service--user-data` QoS be configured for each participant, data writer, and data reader. +Static Discovery requires that the :ref:`qos-user-data` be configured for each participant, data writer, and data reader. This user data must contain the identifier of the entity that is being created. Thus, the user data QoS is not available for general use when using Static Discovery. Static Discovery also requires that the network locators for all entities be determined up front by configuring the transport with the necessary networking information. @@ -756,7 +756,7 @@ Threading OpenDDS creates its own threads for handling I/O, timers, asynchronous jobs, and cleanup tasks. These threads are collectively called *service threads*. -Applications may receive a callback from these threads via :ref:`introduction--listeners` (see :ref:`conditions_and_listeners--listeners`). +Applications may receive a callback from these threads via :ref:`conditions_and_listeners--listeners`. When publishing a sample, OpenDDS normally attempts to send the sample to any connected subscribers using the calling thread. If the send call would block, then the sample may be queued for sending on a separate service thread. diff --git a/docs/devguide/run_time_configuration.rst b/docs/devguide/run_time_configuration.rst index cd8d1a80bcc..03986f0473f 100644 --- a/docs/devguide/run_time_configuration.rst +++ b/docs/devguide/run_time_configuration.rst @@ -2194,7 +2194,7 @@ Transport Instance Properties Sect<7.4.5> Transport instances are specified in the OpenDDS configuration file via sections with the format of ``[transport/]``, where ```` is a unique name for that instance within that process. -Each transport instance must specify the :val:`[transport]transport_type=tcp` option with a valid transport implementation type. +Each transport instance must specify the :prop:`[transport]transport_type` option with a valid transport implementation type. The following sections list the other options that can be specified, starting with those options common to all transport types and following with those specific to each transport type. When using dynamic libraries, the OpenDDS transport libraries are dynamically loaded whenever an instance of that type is defined in a configuration file.