From 39acad62881a496f4ac7b3ecd9d8ce21b484383b Mon Sep 17 00:00:00 2001 From: Marcus B Spencer Date: Fri, 31 Oct 2025 15:16:15 -0500 Subject: [PATCH 1/3] fix(specs): fix relay formatting errors First error (introduced in #961) fixed is where the "The relay immediately terminates the connection after sending this." is not included in the enumeration above. That statement only applies in the case of RelayFull. Second error is that the response codes right after the "Protocol defined responses" comment are actually considered a part of the comment because the indentation level is 1 higher, and therefore won't be displayed. According to https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#comments: > Arbitrary indented text may be used on the lines following the explicit markup start: > ``` > .. This is a comment > .. > _so: is this! > ``` Signed-off-by: Marcus B Spencer --- specs/relay-v1.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specs/relay-v1.rst b/specs/relay-v1.rst index 1c5df3b4..77dfe854 100644 --- a/specs/relay-v1.rst +++ b/specs/relay-v1.rst @@ -132,8 +132,7 @@ messages: 2. ResponseAlreadyConnected - Session is full (both sides already connected) 3. ResponseSuccess - You have successfully joined the session 4. RelayFull - Relay limits are too strict for you to be able to join the session. - -The relay immediately terminates the connection after sending this. + The relay immediately terminates the connection after sending this. After the successful response, all the bytes written and received will be relayed between the two devices in the session directly. @@ -288,6 +287,9 @@ Response message (Type = 4) Message associated with the code. .. Protocol defined responses: + +:: + 1. ResponseSuccess = Response{0, "success"} 2. ResponseNotFound = Response{1, "not found"} 3. ResponseAlreadyConnected = Response{2, "already connected"} From 82e310296f9c6f9afece32b9de5811af64ab31f0 Mon Sep 17 00:00:00 2001 From: Marcus B Spencer Date: Fri, 31 Oct 2025 15:34:15 -0500 Subject: [PATCH 2/3] fix: remove numerical prefix for response codes Signed-off-by: Marcus B Spencer --- specs/relay-v1.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specs/relay-v1.rst b/specs/relay-v1.rst index 77dfe854..fb710846 100644 --- a/specs/relay-v1.rst +++ b/specs/relay-v1.rst @@ -290,11 +290,11 @@ Response message (Type = 4) :: - 1. ResponseSuccess = Response{0, "success"} - 2. ResponseNotFound = Response{1, "not found"} - 3. ResponseAlreadyConnected = Response{2, "already connected"} - 4. ResponseInternalError = Response{99, "internal error"} - 5. ResponseUnexpectedMessage = Response{100, "unexpected message"} + ResponseSuccess = Response{0, "success"} + ResponseNotFound = Response{1, "not found"} + ResponseAlreadyConnected = Response{2, "already connected"} + ResponseInternalError = Response{99, "internal error"} + ResponseUnexpectedMessage = Response{100, "unexpected message"} ConnectRequest message (Type = 5) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 2143d8a627824a3ca819342919f1d402b3a32dc6 Mon Sep 17 00:00:00 2001 From: Marcus B Spencer Date: Fri, 31 Oct 2025 15:48:42 -0500 Subject: [PATCH 3/3] wip Signed-off-by: Marcus B Spencer --- specs/relay-v1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/relay-v1.rst b/specs/relay-v1.rst index fb710846..6ff18260 100644 --- a/specs/relay-v1.rst +++ b/specs/relay-v1.rst @@ -132,7 +132,7 @@ messages: 2. ResponseAlreadyConnected - Session is full (both sides already connected) 3. ResponseSuccess - You have successfully joined the session 4. RelayFull - Relay limits are too strict for you to be able to join the session. - The relay immediately terminates the connection after sending this. + The relay immediately terminates the connection after sending this. After the successful response, all the bytes written and received will be relayed between the two devices in the session directly.