From d1fc0334f4bacba650127bc6a9dac7056aa0d367 Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Sun, 26 Jan 2025 11:23:28 +0100 Subject: [PATCH 1/3] DOCS(dev): Replace nbsp with normal spaces --- .../establishing_connection.rst | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/dev/network-protocol/establishing_connection.rst b/docs/dev/network-protocol/establishing_connection.rst index 71c3b0323cf..6044126e19d 100644 --- a/docs/dev/network-protocol/establishing_connection.rst +++ b/docs/dev/network-protocol/establishing_connection.rst @@ -35,13 +35,13 @@ information using the Version message. The message structure is described below. +--------------------------------------+ | Version | +===========================+==========+ - | version   | uint32 | + | version | uint32 | +---------------------------+----------+ - | release | string | + | release | string | +---------------------------+----------+ | os | string | +---------------------------+----------+ - | os_version | string | + | os_version | string | +---------------------------+----------+ The version field is a combination of major, minor and patch version numbers (e.g. 1.2.0) @@ -54,7 +54,7 @@ fields are common strings containing additional information. +---------------------------+----------+----------+ | Major | Minor | Patch | +===========================+==========+==========+ - | 2 bytes | 1 byte | 1 byte | + | 2 bytes | 1 byte | 1 byte | +---------------------------+----------+----------+ The version information may be used as part of the *SuggestConfig* checks, which usually @@ -71,9 +71,9 @@ any way at the moment. +---------------+-------------------------------------------+ | 1.2.2 | CELT 0.7.1 codec support | +---------------+-------------------------------------------+ - | 1.2.3 | CELT 0.11.0 codec | + | 1.2.3 | CELT 0.11.0 codec | +---------------+-------------------------------------------+ - | 1.2.4 | Opus codec support, SuggestConfig message | + | 1.2.4 | Opus codec support, SuggestConfig message | +---------------+-------------------------------------------+ Authenticate @@ -89,9 +89,9 @@ message. +-----------------------------------------------+ | Authenticate | +===========================+===================+ - | username   | string | + | username | string | +---------------------------+-------------------+ - | password | string | + | password | string | +---------------------------+-------------------+ | tokens | string | +---------------------------+-------------------+ @@ -123,9 +123,9 @@ below. The encryption itself is described in a later section. +-----------------------------------------------+ | CryptSetup | +===========================+===================+ - | key   | bytes | + | key | bytes | +---------------------------+-------------------+ - | client_nonce | bytes | + | client_nonce | bytes | +---------------------------+-------------------+ | server_nonce | bytes | +---------------------------+-------------------+ @@ -147,7 +147,7 @@ these. The full structure of these ChannelState messages is shown below: +===========================+===================+ | channel_id | uint32 | +---------------------------+-------------------+ - | parent | uint32 | + | parent | uint32 | +---------------------------+-------------------+ | name | string | +---------------------------+-------------------+ @@ -157,7 +157,7 @@ these. The full structure of these ChannelState messages is shown below: +---------------------------+-------------------+ | links_add | repeated uint32 | +---------------------------+-------------------+ - | links_remove | repeated uint32 | + | links_remove | repeated uint32 | +---------------------------+-------------------+ | temporary | optional bool | +---------------------------+-------------------+ @@ -181,7 +181,7 @@ currently on the server, including the user that is currently connecting. +===========================+===================+ | session | uint32 | +---------------------------+-------------------+ - | actor | uint32 | + | actor | uint32 | +---------------------------+-------------------+ | name | string | +---------------------------+-------------------+ @@ -189,31 +189,31 @@ currently on the server, including the user that is currently connecting. +---------------------------+-------------------+ | channel_id | uint32 | +---------------------------+-------------------+ - | mute | bool | + | mute | bool | +---------------------------+-------------------+ - | deaf | bool | + | deaf | bool | +---------------------------+-------------------+ - | suppress | bool | + | suppress | bool | +---------------------------+-------------------+ | self_mute | bool | +---------------------------+-------------------+ - | self_deaf | bool | + | self_deaf | bool | +---------------------------+-------------------+ - | texture | bytes | + | texture | bytes | +---------------------------+-------------------+ - | plugin_context | bytes | + | plugin_context | bytes | +---------------------------+-------------------+ - | plugin_identity | string | + | plugin_identity | string | +---------------------------+-------------------+ | comment | string | +---------------------------+-------------------+ - | hash | string | + | hash | string | +---------------------------+-------------------+ - | comment_hash | bytes | + | comment_hash | bytes | +---------------------------+-------------------+ -  | texture_hash | bytes | + | texture_hash | bytes | +---------------------------+-------------------+ - | priority_speaker | bool | + | priority_speaker | bool | +---------------------------+-------------------+ | recording | bool | +---------------------------+-------------------+ From 2aaae8c375b38e6598d7a9ba63a1e983cc1a1369 Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Sun, 26 Jan 2025 12:52:53 +0100 Subject: [PATCH 2/3] DOCS(dev): Fix UTP to TCP ref The cross-document reference apparently worked on readthedocs (our previous docs), but does not work on GitHub. The cross-document figure reference is replaced with a file reference. --- docs/dev/network-protocol/voice_data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/network-protocol/voice_data.rst b/docs/dev/network-protocol/voice_data.rst index ee3dd1872e7..57623677b2b 100644 --- a/docs/dev/network-protocol/voice_data.rst +++ b/docs/dev/network-protocol/voice_data.rst @@ -321,7 +321,7 @@ Tunneling audio over TCP If the UDP channel isn't available the voice packets can be transmitted through the TCP transport used for the control channel. These messages use the normal -TCP prefixing, as shown in figure :ref:`mumble-packet`: 16-bit message type +TCP prefixing, as shown in `Protocol Stack TCP `_: 16-bit message type followed by 32-bit message length. However unlike other TCP messages, the audio packets are not encoded as protocol buffer messages but instead the raw audio packet described in `Packet format`_ should be written to the TCP socket From 5992aa376557f461531c97aceb0078779e7892de Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Sun, 26 Jan 2025 13:24:35 +0100 Subject: [PATCH 3/3] DOCS(dev): Drop broken, unnecessary fig ref The figure follows below the paragraph. --- docs/dev/network-protocol/establishing_connection.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/network-protocol/establishing_connection.rst b/docs/dev/network-protocol/establishing_connection.rst index 6044126e19d..ba6c2ebfef0 100644 --- a/docs/dev/network-protocol/establishing_connection.rst +++ b/docs/dev/network-protocol/establishing_connection.rst @@ -46,7 +46,7 @@ information using the Version message. The message structure is described below. The version field is a combination of major, minor and patch version numbers (e.g. 1.2.0) so that major number takes two bytes and minor and patch numbers take one byte each. -The structure is shown in figure \ref{fig:versionEncoding}. The release, os and os\_version +The release, os and os\_version fields are common strings containing additional information. .. table:: Version field encoding (uint32)