From 784599bd666cb4b2a339d4dfa8ace1a1cca0b89e Mon Sep 17 00:00:00 2001 From: JesusPoderoso Date: Mon, 20 Feb 2023 10:43:30 +0100 Subject: [PATCH 1/3] Refs #17206: Restore domainID tag in domain participant XML section Signed-off-by: JesusPoderoso --- .../xml_configuration/domainparticipant.rst | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst index 3e5b8d30c..fecf3bc0a 100644 --- a/docs/fastdds/xml_configuration/domainparticipant.rst +++ b/docs/fastdds/xml_configuration/domainparticipant.rst @@ -41,8 +41,26 @@ The ```` element has two attributes defined: ``profile_name`` and ` DomainParticipant configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ```` element has as child element ```` under which all the DomainParticipant configuration -options belong. +The ```` element has two child elements: ```` and ````. +All the DomainParticipant configuration options belong to the ```` element, except for the DDS |DomainId-api| +which is defined by the ```` element. +Below a list with the configuration XML elements is presented: + ++----------------+----------------------------------------------------------------------------+--------------+---------+ +| Name | Description | Values | Default | ++================+============================================================================+==============+=========+ +| ```` | DomainId to be used by the DomainParticipant. | ``uint32_t`` | 0 | +| | See :ref:`dds_layer_domainParticipant_creation_profile`. | | | ++----------------+----------------------------------------------------------------------------+--------------+---------+ +| ```` | *Fast DDS* DomainParticipant configurations. |br| | :ref:`RTPS` | | +| | See :ref:`RTPS`. | | | ++----------------+----------------------------------------------------------------------------+--------------+---------+ + +.. _RTPS: + +RTPS element type +""""""""""""""""" + The following is a list with all the possible child XML elements of the ```` element. These elements allow the user to define the DomainParticipant configuration. From 03566788dacdf491e11fdf118e81b73045dfbbc9 Mon Sep 17 00:00:00 2001 From: JesusPoderoso Date: Mon, 20 Feb 2023 15:07:14 +0100 Subject: [PATCH 2/3] Refs #17206: Restore domainID tag XML snippets Signed-off-by: JesusPoderoso --- code/XMLTester.xml | 3 ++- code/XMLTesterExample.xml | 1 + docs/fastdds/xml_configuration/domainparticipant.rst | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/code/XMLTester.xml b/code/XMLTester.xml index ab25e34dd..f2a548e7b 100644 --- a/code/XMLTester.xml +++ b/code/XMLTester.xml @@ -955,6 +955,7 @@ +4 XML-BUILTIN<--> @@ -3465,4 +3466,4 @@ - \ No newline at end of file + diff --git a/code/XMLTesterExample.xml b/code/XMLTesterExample.xml index 1ea44932b..9a618a351 100644 --- a/code/XMLTesterExample.xml +++ b/code/XMLTesterExample.xml @@ -73,6 +73,7 @@ + 4 Participant Name diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst index fecf3bc0a..14766b934 100644 --- a/docs/fastdds/xml_configuration/domainparticipant.rst +++ b/docs/fastdds/xml_configuration/domainparticipant.rst @@ -36,7 +36,7 @@ The ```` element has two attributes defined: ``profile_name`` and ` DomainParticipant's creation. - Optional -.. _domainparticipantconfig: +.. _domainparticipantconfig: DomainParticipant configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 194b9f3d0a6e3c66ca2e24c423390940476b2857 Mon Sep 17 00:00:00 2001 From: JesusPoderoso Date: Tue, 21 Feb 2023 10:38:22 +0100 Subject: [PATCH 3/3] Refs #17206: Apply revision changes Signed-off-by: JesusPoderoso --- code/XMLTester.xml | 2 +- docs/fastdds/xml_configuration/domainparticipant.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/code/XMLTester.xml b/code/XMLTester.xml index f2a548e7b..b9aa57423 100644 --- a/code/XMLTester.xml +++ b/code/XMLTester.xml @@ -828,6 +828,7 @@ --> + 4 DomainParticipant Name @@ -955,7 +956,6 @@ -4 XML-BUILTIN<--> diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst index 14766b934..6261bdb5a 100644 --- a/docs/fastdds/xml_configuration/domainparticipant.rst +++ b/docs/fastdds/xml_configuration/domainparticipant.rst @@ -36,12 +36,12 @@ The ```` element has two attributes defined: ``profile_name`` and ` DomainParticipant's creation. - Optional -.. _domainparticipantconfig: +.. _domainparticipantconfig: DomainParticipant configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ```` element has two child elements: ```` and ````. +The ```` element has two child elements: ```` and ````. All the DomainParticipant configuration options belong to the ```` element, except for the DDS |DomainId-api| which is defined by the ```` element. Below a list with the configuration XML elements is presented: @@ -184,7 +184,7 @@ These elements allow the user to define the DomainParticipant configuration. :language: xml :start-after: XML-PARTICIPANT<--> :end-before: <--> - :lines: 2-3, 5-87, 89 + :lines: 2-3, 5-88, 90 .. note::