Improve QoS Documentation #4520
Conversation
iguessthislldo
commented
Mar 14, 2024
iguessthislldo
commented
- Quality of Service
- Rearranged to remove large default value tables.
- Added Data Representation and Type Consistency Enforcement.
- Every policy now has a box that says if it's mutable, if it affects writer-reader association, its default values, and links to the spec definition.
- Added many links to QoS policies
- Move fnmatch expressions into an "annex" file so it can be common between security and partitions QoS.
- Add definitions for "instance", "unregister", and "dispose" to the glossary.
- Quality of Service - Rearranged to remove large default value tables. - Added Data Representation and Type Consistency Enforcement. - Every policy now has a box that says if it's mutable, if it affects writer-reader association, its default values, and links to the spec definition. - Added many links to QoS policies - Move fnmatch expressions into an "annex" file so it can be common between security and partitions QoS. - Add definitions for "instance", "unregister", and "dispose" to the glossary.
|
The main change, the info boxes for the QoS, can be seen here https://opendds--4520.org.readthedocs.build/en/4520/devguide/quality_of_service.html#reliability-qos |
|
Links to all the changes here: https://opendds--4520.org.readthedocs.build/en/4520/news.html#documentation |
|
|
||
| ``DURATION_INFINITE_SEC`` | ||
| When using :ref:`dds_security`, the user data of a participant can be leaked in unsecured discovery messages. | ||
| Enabling ``[rtps_discovery]SecureParticipantUserData`` will only send and provide the real user data when it can be securely sent. |
There was a problem hiding this comment.
This looks strange in the rendered document. The [rtps_discovery]SecureParticipantUserData should look like it appears in the ini format, or just link to the other section.
There was a problem hiding this comment.
This is what what the rendered config domain links look like. Here is the example RST for the config domain. Right now the links looks the same as the input except for sections discriminators, which appear like [transport] default_address (rtps_udp).
There was a problem hiding this comment.
Maybe this is something we can address in a follow-on PR?
Co-authored-by: Justin Wilson <wilsonj@unityfoundation.io>
Co-authored-by: Son Dinh <technology789@gmail.com>
