From 1e330328870b3830b8ee477454b3c541e6f23e9e Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 22 Apr 2024 12:01:37 +0200 Subject: [PATCH] Update docs to force unlimited ResourceLimits if lower or equal to zero (#738) (#741) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: JesusPoderoso (cherry picked from commit 495f5a21b2808b5d9d33bb771eff8a62ec81678f) Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> --- .../dds_layer/core/policy/standardQosPolicies.rst | 6 +++--- docs/fastdds/xml_configuration/common.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst b/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst index eb0b5afc8..9758ebbe3 100644 --- a/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst +++ b/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst @@ -1217,14 +1217,14 @@ List of QoS Policy data members: can manage across all the instances associated with it. In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter. - **Value 0 means infinite resources.** + **Value less or equal to 0 means infinite resources.** * |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or DataReader can manage. - **Value 0 means infinite resources.** + **Value less or equal to 0 means infinite resources.** * |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance that the DataWriter or DataReader can manage. - **Value 0 means infinite resources.** + **Value less or equal to 0 means infinite resources.** * |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on initialization. * |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on diff --git a/docs/fastdds/xml_configuration/common.rst b/docs/fastdds/xml_configuration/common.rst index 2f4279908..2ea3b90f3 100644 --- a/docs/fastdds/xml_configuration/common.rst +++ b/docs/fastdds/xml_configuration/common.rst @@ -300,17 +300,17 @@ Please refer to :ref:`ResourceLimitsQosPolicy` for further information on Resour +--------------------------------+-----------------------------------------------------------+---------------+---------+ | Name | Description | Values | Default | +================================+===========================================================+===============+=========+ -| ```` | It must verify that: | ``uint32_t`` | 5000 | +| ```` | It must verify that: | ``int32_t`` | 5000 | | | ```` `>=` ````. | | | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It defines the maximum number of instances. | ``uint32_t`` | 10 | +| ```` | It defines the maximum number of instances. | ``int32_t`` | 10 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It must verify that: :ref:`HistoryQos ` | ``uint32_t`` | 400 | +| ```` | It must verify that: :ref:`HistoryQos ` | ``int32_t`` | 400 | | | ```` `<=` ````. | | | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It controls the maximum number of samples to be stored. | ``uint32_t`` | 100 | +| ```` | It controls the maximum number of samples to be stored. | ``int32_t`` | 100 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | The number of extra samples to allocate on the pool. | ``uint32_t`` | 1 | +| ```` | The number of extra samples to allocate on the pool. | ``int32_t`` | 1 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ .. _CommonQOS: