Documentation Fixes from 4784

Also added news for GDB extension.
iguessthislldo · Oct 10, 2024 · d8fbabb · d8fbabb
1 parent 44f8dc8
commit d8fbabb
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 1 deletion.
diff --git a/docs/devguide/quality_of_service.rst b/docs/devguide/quality_of_service.rst
@@ -544,6 +544,10 @@ The ``max_samples`` member specifies the maximum number of samples a single data
 The ``max_instances`` member specifies the maximum number of instances that a data writer or data reader can manage.
 The ``max_samples_per_instance`` member specifies the maximum number of samples that can be managed for an individual instance in a single data writer or data reader.
 
+.. warning::
+
+  Setting these to very high values may exhaust available memory.
+
 Resources are used by the data writer to queue samples written to the data writer but not yet sent to all data readers because of backpressure from the transport.
 Resources are used by the data reader to queue samples that have been received, but not yet read/taken from the data reader.
 
@@ -1226,6 +1230,10 @@ Reader Data Lifecycle QoS
 
 The reader data lifecycle QoS policy controls the lifecycle of :term:`instance`\s managed by a :term:`DataReader`.
 
+.. warning::
+
+  The default values (never purging) might result in increasing memory usage over time for each new instance received.
+
 .. important::
 
   This policy is :ref:`mutable <qos-changing>` and does not affect association.
@@ -1275,9 +1283,11 @@ This policy could, for example, permit a late-joining data writer to prolong the
 
 The ``autopurge_nowriter_samples_delay`` controls how long the data reader waits before reclaiming resources once an instance transitions to the ``NOT_ALIVE_NO_WRITERS`` state.
 By default, ``autopurge_nowriter_samples_delay`` is infinite.
+Use :cfg:prop:`bit_autopurge_nowriter_samples_delay` to set this for :ref:`built-in data readers <bit>`.
 
 The ``autopurge_disposed_samples_delay`` controls how long the data reader waits before reclaiming resources once an instance transitions to the ``NOT_ALIVE_DISPOSED`` state.
 By default, ``autopurge_disposed_samples_delay`` is infinite.
+Use :cfg:prop:`bit_autopurge_disposed_samples_delay` to set this for :ref:`built-in data readers <bit>`.
 
 .. _qos-time-based-filter:
 .. _quality_of_service--time-based-filter:

diff --git a/docs/devguide/run_time_configuration.rst b/docs/devguide/run_time_configuration.rst
@@ -369,6 +369,16 @@ For example:
 
 .. sec:: common
 
+  .. prop:: bit_autopurge_nowriter_samples_delay
+    :default: ``DURATION_INFINITE_SEC`` (disabled)
+
+    Sets the ``autopurge_nowriter_samples_delay`` value of the :ref:`quality_of_service--reader-data-lifecycle` for :ref:`built-in data readers <bit>`.
+
+  .. prop:: bit_autopurge_disposed_samples_delay
+    :default: ``DURATION_INFINITE_SEC`` (disabled)
+
+    Sets the ``autopurge_disposed_samples_delay`` value of the :ref:`quality_of_service--reader-data-lifecycle` for :ref:`built-in data readers <bit>`.
+
   .. prop:: DCPSBidirGIOP=<boolean>
     :default: ``1`` (enabled)
 
@@ -3331,7 +3341,7 @@ See :ref:`config-common` for options controlling the destination and formatting
 The highest level logging is controlled by the general log levels listed in the following table.
 
 .. list-table::
-   :header-rows: 1
+  :header-rows: 1
 
   * - Level
 

diff --git a/docs/news.d/doc-fixes.rst b/docs/news.d/doc-fixes.rst
@@ -0,0 +1,4 @@
+.. news-prs: 1
+.. news-start-section: Documentation
+- Documented the :cfg:prop:`bit_autopurge_nowriter_samples_delay` and :cfg:prop:`bit_autopurge_disposed_samples_delay` configuration properties.
+.. news-end-section
diff --git a/docs/news.d/gdb.rst b/docs/news.d/gdb.rst
@@ -0,0 +1,4 @@
+.. news-prs: 4727 4791
+.. news-start-section: Additions
+- Embedded a :ghfile:`GDB extension <tools/scripts/gdbext.py>` in ``libOpenDDS_Dcps`` to help make debugging OpenDDS in GDB a bit easier.
+.. news-end-section