Bug #111984 Typos and inconsistencies in the doxygen doc for the protocol

Submitted: 7 Aug 2023 7:53 Modified: 23 Aug 2023 20:16
Reporter: Davide Riva Email Updates:
Status: Verified Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:8.0, 8.1 OS:Any
Assigned to: Marc ALFF CPU Architecture:Any

[7 Aug 2023 7:53] Davide Riva
Description:
While reading the Client/Server docs (https://dev.mysql.com/doc/dev/mysql-server/latest/), I've found some typos and inconsistencies:

# https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_connection_phase_packets_p...

* auth_plugin_name's type should be "string<NUL>", not "NULL"

# https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_connection_phase_packets_p...

* If capabilities & CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA, auth_response's type should be "string<lenenc>" instead of "string<length>"

# https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_ok_packet.html

* "if capabilities & CLIENT_SESSION_TRACK" misses a curly bracket at the end

How to repeat:
Refer to the links in the description to see the typos/inconsistencies
[7 Aug 2023 9:02] MySQL Verification Team
Hello Davide,

Thank you for the report and feedback.

regards,
Umesh
[9 Aug 2023 12:29] Davide Riva
I've found another typo:

# https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_com_statistics.html

* "Returns elther a string<EOF>" should be "Returns either a string<EOF> or an ERR_Packet"

Could you confirm?
[12 Aug 2023 18:35] Davide Riva
Hi, I've found another typo.

# https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_binary_resultset.html#sect...
# Section "ProtocolBinary::MYSQL_TYPE_TIME"

* The last example has "01" as a valid time binary representation, but it should be "00" instead.
[16 Aug 2023 16:18] Davide Riva
Hi, here's a newly found typo:

# https://dev.mysql.com/doc/dev/mysql-server/8.1.0/page_protocol_com_stmt_prepare.html#sect_...

* The first example after the "Column definition block" has some "|" chars that shouldn't be there. Spaces should replace them.
[22 Aug 2023 13:29] Davide Riva
I've found another typo:

# https://dev.mysql.com/doc/dev/mysql-server/8.1.0/page_protocol_com_stmt_execute.html

* if (num_params > 0 || (CLIENT_QUERY_ATTRIBUTES && (flags & PARAMETER_COUNT_AVAILABLE)) {

The number of "(" does not match the number of corresponding ")"
[23 Aug 2023 20:16] Davide Riva
# https://dev.mysql.com/doc/dev/mysql-server/8.1.0/page_protocol_com_query_response_text_res...

* In the "Protocol::ColumnDefinition41" session, two unused bytes at the end of the packet are present but not documented (see "Binary Protocol Resultset - Example" in https://dev.mysql.com/doc/dev/mysql-server/8.1.0/page_protocol_binary_resultset.html#sect_... as a reference)

Portions of this website are copyright © 2001, 2002 The PHP Group

Page generated in 0.040 sec. using MySQL 8.4.7-u6-cloud

Timestamp references displayed by the system are UTC.
Content reproduced on this site is the property of the respective copyright holders.
It is not reviewed in advance by Oracle and does not necessarily represent the opinion of Oracle or any other party.