Issue 16957: Editing issues (ddsi-rtps-rtf)
Source: OCI (Mr. Adam Mitz, mitza(at)objectcomputing.com)
Nature: Uncategorized Issue
Severity: 
Summary: The following collection of proposed changes represents fixes to problems in the editing of the specification.
Section: 3
Page: 1
Change: DDS 1.1 is obsolete; CORBA should be referenced for IDL/CDR; IETF RFCs 1321 and 1305 should be referenced
Section: 8.2.4.2, Paragraph 2
Page: 21
Change: First two octets of prefix are fixed due to issue 12509
Section: 8.3.6.3, Bullet 2 and Footnote 2
Page: 43
Change: PROTOCOL_RTPS is not defined by PSM
Section: 8.3.7.3.2, Table 8.35
Page: 50
Change: KeyFlag is missing from the table
Section: 8.3.7.3.2, Table 8.35
Page: 51
Change: Remove the line "Present only if DataFlag is set in the header", as DataFrag has no such flag.  Remove the line "Present only if either the DataFlag or the KeyFlag are set in the header", as DataFrag has no DataFlag.  In the first bullet point replace "If the DataFlag is set" with "If the KeyFlag is not set".
Section: 8.4.1
Page: 63
Change: Section 8.4.13 (Writer Liveliness) is missing from this list.
Section: 8.4.7.1, Figure 8.15
Page: 72
Change: resendDataPeriod is unused, it should be removed
Section: 8.4.7.2, Table 8.49
Page: 75
Change: resendDataPeriod is unused, it should be removed
Section: 8.4.7.2, Table 8.50
Page: 76
Change: Locator_t in this table should be ReaderLocator
Section: 8.4.7.2.1
Page: 76
Change: resendDataPeriod is unused, it should be removed
Section: 8.4.7.2.2, 8.4.7.2.3
Page: 76
Change: Locator_t in these sections should be ReaderLocator
Section: 8.4.7.3
Page: 77
Change: In figure 8.15, type of locator is Locator_t[*] but the [*] is missing from this table and the text should reflect the true cardinality.
Section: 8.4.9.2
Page: 93
Change: The sentence fragment "Submessages are used…" is nonsensical, it should be removed.
Section: 8.5.3.2, Table 8.73
Page: 127
Change: The six constants for BuiltInEndpoints (each constant describes an endpoint, not an endpoint set) are all missing from the PSM
Section: 8.5.3.3, Figure 8.29
Page: 128
Change: Remove figure 8.29, it is a duplicate of figure 8.28
Section: 9.3.1.5
Page: 153
Change: OMG Issue 12509 was resolved but the changed text is missing here
Section: 9.3.2, Table 9.4
Page: 153
Change: OMG Issue 12507 was resolved but the assigned Vendor IDs are not listed.  If they should not be listed in the spec, a URL to the appropriate omg.org web site should be listed here.
Section: 9.3.2, Table 9.4
Page: 156
Change: ReliabilityKind_t is not used on the wire, it should be a PIM-only concept and removed from the PSM
Section: 9.3.2, Table 9.4
Page: 157
Change: Property_t and EntityName_t are not used by the protocol, they should be removed
Section: 9.3.2, Table 9.4
Page: 158
Change: Three problems with the constants for BuiltinEndpoints: 1. the constants don't match the table in the PSM, so the reader of the spec must guess to determine how they are used.  2. constants corresponding to propagation of Topic discovery data are missing.  3. constants for 'participant proxy' and 'participant state' need further explanation (or removal from the spec)
Section: 9.4.5.3, block diagram
Page: 170
Change: Flag "K" is missing from the flags byte
Section: 9.6.2.1
Page: 180
Change: The wire-representation diagram is missing the participantGuidPrefix and kind fields (also see OMG Issue 12501)
Section: 9.6.2.2, Table 9.10
Page: 181
Change: remoteWriterGuid belongs to WriterProxy, not ReaderProxy
Section: 9.6.2.2, Table 9.10
Page: 181
Change: Table 9.10 caption is incorrect
Section: 9.6.2.2.2, Table 9.12
Page: 184
Change: The following ParameterIds are not used for built-in entities and therefore do not belong in this table: PID_BUILTIN_ENDPOINT_SET, PID_PROPERTY_LIST, PID_TYPE_MAX_SIZE_SERIALIZED, PID_ENTITY_NAME, PID_KEY_HASH, PID_STATUS_INFO (the last six rows).  Some of them are already in Table 9.14.
Section: 9.6.2.2.2, Table 9.13
Page: 187
Change: The presence of the final three rows of the table with "Reserved for future use" is confusing, why is it in the specification if all (non-vendor-specific) PIDs are effectively reserved.
Section: 9.6.3, Table 9.14
Page: 188
Change: PID_DIRECTED_WRITE and PID_ORIGINAL_WRITER_INFO are not described in the subsequent subsections.
Section: 9.6.3.2, Table 9.16
Page: 190
Change: KeyHashSuffix does not exist; remove this row from the table.  The row for SerializedData should be sufficient to describe the use of PID_COHERENT_SET.

Resolution: 
Revised Text: 
Actions taken:
December 27, 2011: received issue
Discussion: 

End of Annotations:=====
s is issue # 16957

Issues submission for OMG formal/2010-11-01, The Real-time Publish-Subscribe Wire Protocol DDS Interoperability Wire Protocol Specification (DDS-RTPS) Version 2.1

December 27, 2011
Adam Mitz (mitza@ociweb.com)
Senior Software Engineer
Object Computing, Inc. (OMG Member

Editing issues

The following collection of proposed changes represents fixes to problems in the editing of the specification.
Section: 3
Page: 1
Change: DDS 1.1 is obsolete; CORBA should be referenced for IDL/CDR; IETF RFCs 1321 and 1305 should be referenced

Section: 8.2.4.2, Paragraph 2
Page: 21
Change: First two octets of prefix are fixed due to issue 12509

Section: 8.3.6.3, Bullet 2 and Footnote 2
Page: 43
Change: PROTOCOL_RTPS is not defined by PSM

Section: 8.3.7.3.2, Table 8.35
Page: 50
Change: KeyFlag is missing from the table

Section: 8.3.7.3.2, Table 8.35
Page: 51
Change: Remove the line "Present only if DataFlag is set in the header", as DataFrag has no such flag.  Remove the line "Present only if either the DataFlag or the KeyFlag are set in the header", as DataFrag has no DataFlag.  In the first bullet point replace "If the DataFlag is set" with "If the KeyFlag is not set".

Section: 8.4.1
Page: 63
Change: Section 8.4.13 (Writer Liveliness) is missing from this list.

Section: 8.4.7.1, Figure 8.15
Page: 72
Change: resendDataPeriod is unused, it should be removed

Section: 8.4.7.2, Table 8.49
Page: 75
Change: resendDataPeriod is unused, it should be removed

Section: 8.4.7.2, Table 8.50
Page: 76
Change: Locator_t in this table should be ReaderLocator
Section: 8.4.7.2.1
Page: 76
Change: resendDataPeriod is unused, it should be removed

Section: 8.4.7.2.2, 8.4.7.2.3
Page: 76
Change: Locator_t in these sections should be ReaderLocator

Section: 8.4.7.3
Page: 77
Change: In figure 8.15, type of locator is Locator_t[*] but the [*] is missing from this table and the text should reflect the true cardinality.
Section: 8.4.9.2
Page: 93
Change: The sentence fragment "Submessages are used." is nonsensical, it should be removed.

Section: 8.5.3.2, Table 8.73
Page: 127
Change: The six constants for BuiltInEndpoints (each constant describes an endpoint, not an endpoint set) are all missing from the PSM

Section: 8.5.3.3, Figure 8.29
Page: 128
Change: Remove figure 8.29, it is a duplicate of figure 8.28

Section: 9.3.1.5
Page: 153
Change: OMG Issue 12509 was resolved but the changed text is missing here

Section: 9.3.2, Table 9.4
Page: 153
Change: OMG Issue 12507 was resolved but the assigned Vendor IDs are not listed.  If they should not be listed in the spec, a URL to the appropriate omg.org web site should be listed here.

Section: 9.3.2, Table 9.4
Page: 156
Change: ReliabilityKind_t is not used on the wire, it should be a PIM-only concept and removed from the PSM

Section: 9.3.2, Table 9.4
Page: 157
Change: Property_t and EntityName_t are not used by the protocol, they should be removed

Section: 9.3.2, Table 9.4
Page: 158
Change: Three problems with the constants for BuiltinEndpoints: 1. the constants don't match the table in the PSM, so the reader of the spec must guess to determine how they are used.  2. constants corresponding to propagation of Topic discovery data are missing.  3. constants for 'participant proxy' and 'participant state' need further explanation (or removal from the spec)

Section: 9.4.5.3, block diagram
Page: 170
Change: Flag "K" is missing from the flags byte

Section: 9.6.2.1
Page: 180
Change: The wire-representation diagram is missing the participantGuidPrefix and kind fields (also see OMG Issue 12501)

Section: 9.6.2.2, Table 9.10
Page: 181
Change: remoteWriterGuid belongs to WriterProxy, not ReaderProxy

Section: 9.6.2.2, Table 9.10
Page: 181
Change: Table 9.10 caption is incorrect

Section: 9.6.2.2.2, Table 9.12
Page: 184
Change: The following ParameterIds are not used for built-in entities and therefore do not belong in this table: PID_BUILTIN_ENDPOINT_SET, PID_PROPERTY_LIST, PID_TYPE_MAX_SIZE_SERIALIZED, PID_ENTITY_NAME, PID_KEY_HASH, PID_STATUS_INFO (the last six rows).  Some of them are already in Table 9.14.

Section: 9.6.2.2.2, Table 9.13
Page: 187
Change: The presence of the final three rows of the table with "Reserved for future use" is confusing, why is it in the specification if all (non-vendor-specific) PIDs are effectively reserved.

Section: 9.6.3, Table 9.14
Page: 188
Change: PID_DIRECTED_WRITE and PID_ORIGINAL_WRITER_INFO are not described in the subsequent subsections.

Section: 9.6.3.2, Table 9.16
Page: 190
Change: KeyHashSuffix does not exist; remove this row from the table.  The row for SerializedData should be sufficient to describe the use of PID_COHERENT_SET.