Fix master references in stable version (#855)

JesusPoderoso · web-flow · commit f018cc833c47 · 2024-07-09T14:33:50.000+02:00
* Refs #21320: Fix master references in stable version

Signed-off-by: JesusPoderoso &lt;jesuspoderoso@eprosima.com&gt;

* Refs #21320: Apply Mario' suggestion

Signed-off-by: JesusPoderoso &lt;jesuspoderoso@eprosima.com&gt;

---------

Signed-off-by: JesusPoderoso &lt;jesuspoderoso@eprosima.com&gt;
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ Create a virtual environment and install python3 dependencies.
 ```bash
 python3 -m venv fastdds-docs-venv
 source fastdds-docs-venv/bin/activate
-wget https://raw.githubusercontent.com/eProsima/Fast-DDS-docs/master/docs/requirements.txt
+wget https://raw.githubusercontent.com/eProsima/Fast-DDS-docs/2.x/docs/requirements.txt
 pip3 install -r requirements.txt
 ```
 
diff --git a/docs/fastdds/discovery/discovery_server.rst b/docs/fastdds/discovery/discovery_server.rst
@@ -352,7 +352,7 @@ Full example
 ^^^^^^^^^^^^
 
 The following constitutes a full example on how to configure *server* and *client* both programmatically and using XML.
-You may also have a look at the *eProsima Fast DDS* Github repository, which contains `an example <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/DiscoveryServerExample>`_
+You may also have a look at the *eProsima Fast DDS* Github repository, which contains `an example <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/DiscoveryServerExample>`_
 similar to the one discussed in this section, as well as multiple other examples for different use cases.
 
 Server side setup
diff --git a/docs/fastdds/discovery/static.rst b/docs/fastdds/discovery/static.rst
@@ -67,7 +67,7 @@ and DataReaders) must be statically specified, which is done using dedicated XML
 A |DomainParticipant| may load several of such configuration files so that the information about different entities can
 be contained in one file, or split into different files to keep it more organized.
 *Fast DDS*  provides a
-`Static Discovery example <https://github.com/eProsima/Fast-DDS/blob/master/examples/cpp/dds/StaticHelloWorldExample>`_
+`Static Discovery example <https://github.com/eProsima/Fast-DDS/blob/2.x/examples/cpp/dds/StaticHelloWorldExample>`_
 that implements this EDP discovery protocol.
 
 The following table describes all the possible elements of a STATIC EDP XML configuration file.
diff --git a/docs/fastdds/dynamic_types/examples.rst b/docs/fastdds/dynamic_types/examples.rst
@@ -16,7 +16,7 @@ DynamicHelloWorldExample
 ------------------------
 
 This example is in folder
-`examples/cpp/dds/DynamicHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/DynamicHelloWorldExample>`_
+`examples/cpp/dds/DynamicHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/DynamicHelloWorldExample>`_
 of the `Fast DDS GitHub repository`_.
 It shows the use of DynamicType generation to provide the |TopicDataType|.
 This example is compatible with the classic HelloWorldExample.
@@ -34,7 +34,7 @@ DDSDynamicHelloWorldExample
 ---------------------------
 
 This example uses the DDS API, and can be retrieve from folder
-`examples/cpp/dds/DynamicHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/DynamicHelloWorldExample>`_
+`examples/cpp/dds/DynamicHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/DynamicHelloWorldExample>`_
 of the `Fast DDS GitHub repository`_.
 It shows a publisher that loads a type from an XML file, and shares it during discovery.
 The subscriber discovers the type using :ref:`discovery-time-data-typing`, and registers the
@@ -44,7 +44,7 @@ TypeLookupService
 -----------------
 
 This example uses the DDS API, and it is located in folder
-`examples/cpp/dds/TypeLookupService <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/TypeLookupService>`_
+`examples/cpp/dds/TypeLookupService <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/TypeLookupService>`_
 of the `Fast DDS GitHub repository`_.
 It is very similar to DDSDynamicHelloWorldExample, but the shared type is complex enough to require the
 TypeLookup Service due to the dependency of inner struct types.
diff --git a/docs/fastdds/getting_started/simple_app/includes/publisher.rst b/docs/fastdds/getting_started/simple_app/includes/publisher.rst
@@ -6,7 +6,7 @@ From the `src` directory in the workspace, run the following command to download
 .. code-block:: bash
 
     wget -O HelloWorldPublisher.cpp \
-        https://raw.githubusercontent.com/eProsima/Fast-RTPS-docs/master/code/Examples/C++/DDSHelloWorld/src/HelloWorldPublisher.cpp
+        https://raw.githubusercontent.com/eProsima/Fast-DDS-Docs/2.x/code/Examples/C++/DDSHelloWorld/src/HelloWorldPublisher.cpp
 
 This is the C++ source code for the publisher application.
 It is going to send 10 publications under the topic `HelloWorldTopic`.
diff --git a/docs/fastdds/getting_started/simple_app/includes/subscriber.rst b/docs/fastdds/getting_started/simple_app/includes/subscriber.rst
@@ -6,7 +6,7 @@ From the `src` directory in the workspace, execute the following command to down
 .. code-block:: bash
 
     wget -O HelloWorldSubscriber.cpp \
-        https://raw.githubusercontent.com/eProsima/Fast-RTPS-docs/master/code/Examples/C++/DDSHelloWorld/src/HelloWorldSubscriber.cpp
+        https://raw.githubusercontent.com/eProsima/Fast-DDS-Docs/2.x/code/Examples/C++/DDSHelloWorld/src/HelloWorldSubscriber.cpp
 
 This is the C++ source code for the subscriber application.
 The application runs a subscriber until it receives 10 samples under the topic `HelloWorldTopic`.
diff --git a/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst b/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst
@@ -10,4 +10,4 @@ Next steps
 
 In the *eProsima Fast DDS* Github repository you will find more complex examples that implement DDS communication for
 a multitude of use cases and scenarios. You can find them
-`here <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds>`_.
+`here <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds>`_.
diff --git a/docs/fastdds/getting_started/simple_python_app/includes/publisher.rst b/docs/fastdds/getting_started/simple_python_app/includes/publisher.rst
@@ -6,7 +6,7 @@ From the workspace, run the following command to download the HelloWorldPublishe
 .. code-block:: bash
 
     wget -O HelloWorldPublisher.py \
-        https://raw.githubusercontent.com/eProsima/Fast-RTPS-docs/master/code/Examples/Python/HelloWorld/HelloWorldPublisher.py
+        https://raw.githubusercontent.com/eProsima/Fast-DDS-Docs/2.x/code/Examples/Python/HelloWorld/HelloWorldPublisher.py
 
 This is the Python source code for the publisher application.
 It is going to send 10 publications under the topic `HelloWorldTopic`.
diff --git a/docs/fastdds/getting_started/simple_python_app/includes/subscriber.rst b/docs/fastdds/getting_started/simple_python_app/includes/subscriber.rst
@@ -6,7 +6,7 @@ From the workspace, run the following command to download the HelloWorldSubscrib
 .. code-block:: bash
 
     wget -O HelloWorldSubscriber.py \
-        https://raw.githubusercontent.com/eProsima/Fast-RTPS-docs/master/code/Examples/Python/HelloWorld/HelloWorldSubscriber.py
+        https://raw.githubusercontent.com/eProsima/Fast-DDS-Docs/2.x/code/Examples/Python/HelloWorld/HelloWorldSubscriber.py
 
 This is the Python source code for the subscriber application.
 The application runs a subscriber until the user press *Ctrl+C* receiving samples under the topic HelloWorldTopic.
diff --git a/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst b/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst
@@ -9,4 +9,4 @@ Next steps
 
 In the *eProsima Fast DDS* Github repository you will find more complex examples that implement DDS communication for
 a multitude of use cases and scenarios. You can find them
-`here <https://github.com/eProsima/Fast-DDS-python/tree/master/fastdds_python_examples>`_.
+`here <https://github.com/eProsima/Fast-DDS-python/tree/main/fastdds_python_examples>`_.
diff --git a/docs/fastdds/rtps_layer/rtps_layer.rst b/docs/fastdds/rtps_layer/rtps_layer.rst
@@ -41,8 +41,8 @@ explaining the new features it presents.
 We recommend you to look at the two examples describing how to use the RTPS layer that come with the distribution
 while reading this section.
 They are located in
-`examples/cpp/rtps/AsSocket <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/rtps/AsSocket>`_ and
-`examples/cpp/rtps/Registered <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/rtps/Registered>`_
+`examples/cpp/rtps/AsSocket <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/rtps/AsSocket>`_ and
+`examples/cpp/rtps/Registered <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/rtps/Registered>`_
 
 Managing the Participant
 ^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/fastdds/security/access_control_plugin/access_control_plugin.rst b/docs/fastdds/security/access_control_plugin/access_control_plugin.rst
@@ -107,9 +107,9 @@ The following is an example of the Domain Governance XML file contents.
    :end-before: <!--><-->
    :linenos:
 
-The `Governance XSD file <https://github.com/eProsima/Fast-DDS/blob/master/resources/xsd/governance.xsd>`_ and
+The `Governance XSD file <https://github.com/eProsima/Fast-DDS/blob/2.x/resources/xsd/governance.xsd>`_ and
 the
-`Governance XML example <https://github.com/eProsima/Fast-DDS/blob/master/examples/cpp/dds/SecureHelloWorldExample/certs/governance.xml>`_
+`Governance XML example <https://github.com/eProsima/Fast-DDS/blob/2.x/examples/cpp/dds/SecureHelloWorldExample/certs/governance.xml>`_
 can also be downloaded from the `eProsima Fast DDS Github repository <https://github.com/eProsima/Fast-DDS>`_.
 
 Domain Rules
@@ -444,9 +444,9 @@ The following is an example of the DomainParticipant Permissions XML file conten
    :end-before: <!--><-->
    :linenos:
 
-The `Permissions XSD file <https://github.com/eProsima/Fast-DDS/blob/master/resources/xsd/governance.xsd>`_ and
+The `Permissions XSD file <https://github.com/eProsima/Fast-DDS/blob/2.x/resources/xsd/governance.xsd>`_ and
 the
-`Permissions XML example <https://github.com/eProsima/Fast-DDS/blob/master/examples/cpp/dds/SecureHelloWorldExample/certs/governance.xml>`_
+`Permissions XML example <https://github.com/eProsima/Fast-DDS/blob/2.x/examples/cpp/dds/SecureHelloWorldExample/certs/governance.xml>`_
 can also be downloaded from the `eProsima Fast DDS Github repository <https://github.com/eProsima/Fast-DDS>`_.
 
 Grant Section
diff --git a/docs/fastdds/transport/shared_memory/shared_memory.rst b/docs/fastdds/transport/shared_memory/shared_memory.rst
@@ -277,5 +277,5 @@ HelloWorldExampleSharedMem
 --------------------------
 
 A Shared Memory version of helloworld example can be found in the
-`HelloWorldExampleSharedMem folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/HelloWorldExampleSharedMem>`_.
+`HelloWorldExampleSharedMem folder <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/HelloWorldExampleSharedMem>`_.
 It shows a publisher and a subscriber that communicate through Shared Memory.
diff --git a/docs/fastdds/transport/tcp/tcp.rst b/docs/fastdds/transport/tcp/tcp.rst
@@ -451,6 +451,6 @@ HelloWorldExampleTCP
 --------------------
 
 A TCP version of helloworld example can be found in the
-`HelloWorldExampleTCP folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/HelloWorldExampleTCP>`_.
+`HelloWorldExampleTCP folder <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/HelloWorldExampleTCP>`_.
 It shows a publisher and a subscriber that communicate through TCP.
 The publisher is configured as *TCP server* while the Subscriber is acting as *TCP client*.
diff --git a/docs/fastdds/use_cases/request_reply/request_reply.rst b/docs/fastdds/use_cases/request_reply/request_reply.rst
@@ -152,4 +152,4 @@ For this the client application has to compare the stored |SampleIdentity-api| w
    :start-after: //REQUEST_REPLY_EXAMPLE_CLIENT_RECEIVE_REPLY
    :end-before: //!
 
-.. _Fast DDS repository: https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/RequestReplyExample
+.. _Fast DDS repository: https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/RequestReplyExample
diff --git a/docs/fastdds/use_cases/statistics_module/statistics_module.rst b/docs/fastdds/use_cases/statistics_module/statistics_module.rst
@@ -43,7 +43,7 @@ another application should be configured to subscribe to those topics.
 This application is a DDS standard application where the statistics DataReaders should be created.
 In order to create these statistics DataReaders, the user should follow the next steps:
 
-* Using the `statistics IDL <https://github.com/eProsima/Fast-DDS/blob/master/include/fastdds/statistics/types.idl>`_
+* Using the `statistics IDL <https://github.com/eProsima/Fast-DDS/blob/2.x/include/fastdds/statistics/types.idl>`_
   provided in the public API, generate the |TopicDataTypes-api| with :ref:`Fast DDS-Gen <fastddsgen_usage>`.
 
 * Create the |DomainParticipant-api| and register the |TopicDataTypes-api| and the corresponding statistics
diff --git a/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst b/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
@@ -48,7 +48,7 @@ each other, so they can start sharing user data right away, avoiding the EDP pha
 
 A complete description of the feature can be found at :ref:`discovery_static`.
 There is also a fully functional helloworld example implementing STATIC EDP in the
-`examples/cpp/dds/StaticHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/StaticHelloWorldExample>`_
+`examples/cpp/dds/StaticHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/StaticHelloWorldExample>`_
 folder.
 
 The following subsections present an example configuration where a Publisher in
diff --git a/docs/fastdds/use_cases/zero_copy/zero_copy.rst b/docs/fastdds/use_cases/zero_copy/zero_copy.rst
@@ -169,4 +169,4 @@ Next steps
 
 The *eProsima Fast DDS* Github repository contains the complete example discussed in this section, as well as
 multiple other examples for different use cases. The example implementing Zero-Copy transfers can be found
-`here <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/ZeroCopyExample>`_.
+`here <https://github.com/eProsima/Fast-DDS/tree/2.x/examples/cpp/dds/ZeroCopyExample>`_.
diff --git a/docs/fastdds/xml_configuration/making_xml_profiles.rst b/docs/fastdds/xml_configuration/making_xml_profiles.rst
@@ -38,7 +38,7 @@ The following sections will show implementation examples for each of these profi
     The :ref:`examplexml` section shows an XML file with all the possible configurations and profile types.
     This example is useful as a quick reference to look for a particular property and how to use it.
     The
-    `Fast DDS XSD scheme <https://github.com/eProsima/Fast-DDS/blob/master/resources/xsd/fastRTPS_profiles.xsd>`_
+    `Fast DDS XSD scheme <https://github.com/eProsima/Fast-DDS/blob/2.x/resources/xsd/fastRTPS_profiles.xsd>`_
     can be used as a quick reference too.
 
 .. _loadingapplyingprofiles:
@@ -157,6 +157,6 @@ It also gives the participant a name that mixes literal text with the content fr
 
 .. warning::
 
-    The `Fast DDS XSD schema <https://github.com/eProsima/Fast-DDS/blob/master/resources/xsd/fastRTPS_profiles.xsd>`_
+    The `Fast DDS XSD schema <https://github.com/eProsima/Fast-DDS/blob/2.x/resources/xsd/fastRTPS_profiles.xsd>`_
     does not support the environment variables expansion feature, so validation of an XML file with environment
     variables expansion expressions will fail.
diff --git a/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst b/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst
@@ -5,6 +5,6 @@ In this tutorial, a publisher/subscriber DDS application using *Fast DDS-Gen* ha
 The tutorial also describes how to generate IDL files that contain the description of the Topic data type.
 
 To continue developing DDS applications please take a look at the
-`eProsima Fast DDS examples on github <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_
+`eProsima Fast DDS examples on github <https://github.com/eProsima/Fast-DDS/tree/2.x/examples>`_
 for ideas on how to improve this basic application through different configuration
 options, and also for examples of advanced *Fast DDS* features.
diff --git a/docs/fastddsgen/usage/usage.rst b/docs/fastddsgen/usage/usage.rst
@@ -80,7 +80,7 @@ Where the option choices are:
      - Specifies a custom template used for generating source code. |br|
        This option expects the location of the template and the location of the file where source code output will be
        stored. |br|
-       A custom template example can be found in this `link <https://raw.githubusercontent.com/eProsima/Fast-DDS-Gen/master/resources/Custom.stg>`_
+       A custom template example can be found in this `link <https://raw.githubusercontent.com/eProsima/Fast-DDS-Gen/3.x/resources/Custom.stg>`_
    * - -help
      - Shows the help information
    * - -I <directory>
diff --git a/docs/installation/configuration/cmake_options.rst b/docs/installation/configuration/cmake_options.rst
@@ -86,8 +86,8 @@ dependency on other options.
     *   - :class:`COMPILE_EXAMPLES`
         - Builds the *Fast DDS* examples. It is set to ``ON`` if :class:`EPROSIMA_BUILD` is ``ON`` and |br|
           :class:`EPROSIMA_INSTALLER` is ``OFF``. These examples can be found in the |br|
-          `eProsima Fast DDS <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_
-          `GitHub repository <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_.
+          `eProsima Fast DDS <https://github.com/eProsima/Fast-DDS/tree/2.x/examples>`_
+          `GitHub repository <https://github.com/eProsima/Fast-DDS/tree/2.x/examples>`_.
         - ``ON`` ``OFF``
         - ``OFF``
     *   - :class:`INSTALL_EXAMPLES`
diff --git a/docs/installation/sources/sources_linux.rst b/docs/installation/sources/sources_linux.rst
@@ -220,7 +220,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
 
        mkdir ~/Fast-DDS
        cd ~/Fast-DDS
-       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos
+       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/2.x/fastrtps.repos
        mkdir src
        vcs import src < fastrtps.repos
 
diff --git a/docs/installation/sources/sources_mac.rst b/docs/installation/sources/sources_mac.rst
@@ -174,7 +174,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
 
        mkdir ~/Fast-DDS
        cd ~/Fast-DDS
-       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos
+       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/2.x/fastrtps.repos
        mkdir src
        vcs import src < fastrtps.repos
 
diff --git a/docs/installation/sources/sources_windows.rst b/docs/installation/sources/sources_windows.rst
@@ -270,7 +270,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
 
        mkdir ~\Fast-DDS
        cd ~\Fast-DDS
-       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos -output fastrtps.repos
+       wget https://raw.githubusercontent.com/eProsima/Fast-DDS/2.x/fastrtps.repos -output fastrtps.repos
        mkdir src
        vcs import src --input fastrtps.repos
 
