Skip to content

Commit 5052e4a

Browse files
committed
Update refs to use GitHub syntax
Signed-off-by: Andrea Sorbini <[email protected]>
1 parent dd0f1ea commit 5052e4a

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ For any questions or direct feedback, feel free to reach out to [email protected]
2424
- [RTI Connext DDS Requirements](#rti-connext-dds-requirements)
2525
- [Multiple versions of RTI Connext DDS Professional](#multiple-versions-of-rti-connext-dds-professional)
2626
- [RMW Runtime Configuration](#rmw-runtime-configuration)
27-
- [RMW_CONNEXT_CYCLONE_COMPATIBILITY_MODE](#rmw-connext-cyclone-compatibility-mode)
28-
- [RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS](#rmw-connext-disable-large-data-optimizations)
29-
- [RMW_CONNEXT_DISABLE_FAST_ENDPOINT_DISCOVERY](#rmw-connext-disable-fast-endpoint-discovery)
30-
- [RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY](#rmw-connext-endpoint-qos-override-policy)
31-
- [RMW_CONNEXT_INITIAL_PEERS](#rmw-connext-initial-peers)
32-
- [RMW_CONNEXT_LEGACY_RMW_COMPATIBILITY_MODE](#rmw-connext-legacy-rmw-compatibility-mode)
33-
- [RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY](#rmw-connext-participant-qos-override-policy)
34-
- [RMW_CONNEXT_REQUEST_REPLY_MAPPING](#rmw-connext-request-reply-mapping)
35-
- [RMW_CONNEXT_UDP_INTERFACE](#rmw-connext-udp-interface)
36-
- [RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE](#rmw-connext-use-default-publish-mode)
27+
- [RMW_CONNEXT_CYCLONE_COMPATIBILITY_MODE](#rmw_connext_cyclone_compatibility_mode)
28+
- [RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS](#rmw_connext_disable_large_data_optimizations)
29+
- [RMW_CONNEXT_DISABLE_FAST_ENDPOINT_DISCOVERY](#rmw_connext_disable_fast_endpoint_discovery)
30+
- [RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY](#rmw_connext_endpoint_qos_override_policy)
31+
- [RMW_CONNEXT_INITIAL_PEERS](#rmw_connext_initial_peers)
32+
- [RMW_CONNEXT_LEGACY_RMW_COMPATIBILITY_MODE](#rmw_connext_legacy_rmw_compatibility_mode)
33+
- [RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY](#rmw_connext_participant_qos_override_policy)
34+
- [RMW_CONNEXT_REQUEST_REPLY_MAPPING](#rmw_connext_request_reply_mapping)
35+
- [RMW_CONNEXT_UDP_INTERFACE](#rmw_connext_udp_interface)
36+
- [RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE](#rmw_connext_use_default_publish_mode)
3737
- [DDS Quality of Service Configuration](#dds-quality-of-service-configuration)
3838
- [Customize QoS via XML](#customize-qos-via-xml)
3939
- [Customize DomainParticipant QoS](#customize-domainparticipant-qos)
@@ -896,7 +896,7 @@ to customize the QoS of the DomainParticipant from an external XML file:
896896
By default, `rmw_connextdds` will always overwrite certain fields of the default
897897
DomainParticipant QoS (see [DomainParticipant creation](#domainparticipant-creation)).
898898
These "hard-coded" customizations may be disabled using the "QoS override" policies
899-
selected with variable [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw-connext-participant-qos-override-policy).
899+
selected with variable [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy).
900900
901901
The customization may also be replicated in XML by using the QoS profiles contained
902902
in [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml),
@@ -956,7 +956,7 @@ ovewritten with values coming from the ROS QoS profile.
956956
957957
You can disable this behavior altogether or selectively for specific topics by
958958
selecting one of the alternative "QoS override" policies available via
959-
environment variable [RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY](#rmw-connext-endpoint-qos-override-policy).
959+
environment variable [RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY](#rmw_connext_endpoint_qos_override_policy).
960960
961961
For example, after saving the XML file presented earlier as `./USER_QOS_PROFILES.xml`,
962962
it would be possible to run a `demo_nodes_cpp/talker` instance, and completely disable
@@ -1095,14 +1095,14 @@ Profile `ros2::rmw_connextdds.base_participant` models the DomainParticipan QoS
10951095
settings used by `rmw_connextdds` to change some of Connext's "out of the box"
10961096
QoS, and make it more amenable to use with ROS 2 applications.
10971097
1098-
These settings are only applied by `rmw_connextdds` when [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw-connext-participant-qos-override-policy)
1098+
These settings are only applied by `rmw_connextdds` when [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy)
10991099
is either not set, or set to `all`.
11001100
11011101
#### ros2::rmw_connextdds.base_application
11021102
11031103
Use profile `ros2::rmw_connextdds.base_application` as the base profile when
1104-
[`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw-connext-endpoint-qos-override-policy)
1105-
is set to `never` and/or [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw-connext-participant-qos-override-policy) is set to a value other than `all`.
1104+
[`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw_connext_endpoint_qos_override_policy)
1105+
is set to `never` and/or [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy) is set to a value other than `all`.
11061106
11071107
This profile will configure the DomainParticipant and all "built-in" endpoints with
11081108
the same settings normally used by `rmw_connextdds`.
@@ -1126,7 +1126,7 @@ maximum serialized size of at least 1MB.
11261126
The configuration is derived from Connext's built-in profile `Generic.KeepLastReliable.LargeData`.
11271127
11281128
These optimizations are always applied by `rmw_connextdds` to all "qualified" endpoints,
1129-
unless variable [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw-connext-disable-large-data-optimizations) is used to disabled them.
1129+
unless variable [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw_connext_disable_large_data_optimizations) is used to disabled them.
11301130
11311131
#### ros2::rmw_connextdds.opt.unbounded_data
11321132
@@ -1218,7 +1218,7 @@ operations will also be performed:
12181218
- Register the default Writer History plugin.
12191219
- Register the default Reader History plugin.
12201220
- Unregister the UDP Transport plugin.
1221-
- Configure the UDP Transport plugin to use the interface specified by [`RMW_CONNEXT_UDP_INTERFACE`](#rmw-connext-udp-interface).
1221+
- Configure the UDP Transport plugin to use the interface specified by [`RMW_CONNEXT_UDP_INTERFACE`](#rmw_connext_udp_interface).
12221222
- Re-register the UDP Transport plugin.
12231223
- Register the Shared-memory Transport plugin.
12241224
- Configure the DPDE Discovery plugin with the following settings:
@@ -1269,7 +1269,7 @@ Upon initialization of a context, the following operations will be performed:
12691269
12701270
- Determine the default `DomainParticipantQoS` by calling
12711271
[`DDS_DomainParticipantFactory_get_default_participant_qos()`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/group__DDSDomainParticipantFactoryModule.html#gaf85e5146fe9f1bd10e11fdf871f66c24).
1272-
- In the case of `rmw_connextdds`, based on [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw-connext-participant-qos-override-policy):
1272+
- In the case of `rmw_connextdds`, based on [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy):
12731273
- Tune internal policy `DomainParticipantQos::user_object` to enable sharing of
12741274
DomainParticipants created by `rmw_connextdds` with Connext's C API with C++ applications
12751275
using Connext's C++11 API.
@@ -1293,7 +1293,7 @@ Upon initialization of a context, the following operations will be performed:
12931293
to support propagation of "larger" types (i.e. consisting of many, possibly nested, members).
12941294
- Reduce Connext's "shutdown period" to speed up finalization of a DomainParticipant.
12951295
- Set [`DomainParticipantQos::database::shutdown_cleanup_period`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__DatabaseQosPolicy.html#a17dc46e4dd757576e6cc68487379f6fa) to 10ms.
1296-
- Enable quicker endpoint discovery (depending on [RMW_CONNEXT_DISABLE_FAST_ENDPOINT_DISCOVERY](#rmw-connext-disable-fast-endpoint-discovery)).
1296+
- Enable quicker endpoint discovery (depending on [RMW_CONNEXT_DISABLE_FAST_ENDPOINT_DISCOVERY](#rmw_connext_disable_fast_endpoint_discovery)).
12971297
- Update [`DomainParticipantQos::discovery_config::publication_writer`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__DiscoveryConfigQosPolicy.html#a4dd350ea9eb8f9a2cae267bb5e019981):
12981298
- Set `fast_heartbeat_period` to 100ms.
12991299
- Set `late_joiner_heartbeat_period` to 100ms.
@@ -1528,10 +1528,10 @@ will perform the following operations:
15281528
- Since XML-based configuration is not available with RTI Connext DDS Micro,
15291529
`rmw_connextddsmicro` will fall back to [`DDS_Publisher_get_default_datawriter_qos()`](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/api_c/html/group__DDSPublisherModule.html#ga777a869f4f8d435be23dea15f949f4bf).
15301530
- In the case of `rmw_connextdds`:
1531-
- Based on [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw-connext-endpoint-qos-override-policy),
1531+
- Based on [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw_connext_endpoint_qos_override_policy),
15321532
apply the ROS 2 QoS profile on top of the default QoS policy, and overwrite
15331533
them unless the corresponding ROS 2 policies are set to `SYSTEM_DEFAULT`.
1534-
- Based on [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw-connext-disable-large-data-optimizations), and if the DataWriter's data type
1534+
- Based on [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw_connext_disable_large_data_optimizations), and if the DataWriter's data type
15351535
qualifies as "large data", tune the RTPS reliability protocol settings to
15361536
provide better "out of the box" behavior for these types by updating
15371537
[`DataWriterQos::protocol.rtps_reliable_writer`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__DataWriterProtocolQosPolicy.html#a073f347f5d06730a44c411e5ce25fe6a):
@@ -1545,7 +1545,7 @@ will perform the following operations:
15451545
- Set [`high_watermark`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__RtpsReliableWriterProtocol__t.html#a7dc8a8bb8168a5acc3041f8970e95665) to `10`.
15461546
- Set [`low_watermark`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__RtpsReliableWriterProtocol__t.html#ab603712e435cc4369366afa770700b80) to `0`.
15471547
- Set [`max_heartbeat_retries`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__RtpsReliableWriterProtocol__t.html#a5be67d978618b5995cb517b51231d39d) to `500` (10s @ 50Hz).
1548-
- Based on [`RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE`](#rmw-connext-use-default-publish-mode),
1548+
- Based on [`RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE`](#rmw_connext_use_default_publish_mode),
15491549
overwrite `DataWriterQos::publish_mode::kind` to `ASYNCHRONOUS_PUBLISH_MODE`.
15501550
- The "asynchronous publish mode" is required by RTI Connext DDS to publish data samples
15511551
which require fragmentation because they exceed the underlying transport's MTU.
@@ -1632,10 +1632,10 @@ will perform the following operations:
16321632
- Since XML-based configuration is not available with RTI Connext DDS Micro,
16331633
`rmw_connextddsmicro` will fall back to [`DDS_Subscriber_get_default_datawriter_qos()`]().
16341634
- In the case of `rmw_connextdds`:
1635-
- Based on [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw-connext-endpoint-qos-override-policy),
1635+
- Based on [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw_connext_endpoint_qos_override_policy),
16361636
apply the ROS 2 QoS profile on top of the default QoS policy, and overwrite
16371637
them unless the corresponding ROS 2 policies are set to `SYSTEM_DEFAULT`.
1638-
- Based on [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw-connext-disable-large-data-optimizations), and if the DataReader's data type
1638+
- Based on [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw_connext_disable_large_data_optimizations), and if the DataReader's data type
16391639
qualifies as "large data", tune the RTPS reliability protocol settings to
16401640
provide better "out of the box" behavior for these types.
16411641
- Update [`DataReaderQos::protocol.rtps_reliable_reader`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__DataReaderProtocolQosPolicy.html#ac962c1b10fbf15c0a68d975f9e95d995):

0 commit comments

Comments
 (0)