Bug #111174 The debug options are not fully described in the official documentation (The DBU
Submitted: 28 May 7:52 Modified: 29 Jun 14:06
Reporter: xichao li (OCA) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:8.0 OS:Any
Assigned to: CPU Architecture:Any

[28 May 7:52] xichao li
Description:
In The current official documentation, the supported parameter description for the debug option is incomplete (found in section 5.9.4 The DBUG Package). Missing description of parameter A/a/T.
As a result, when related functions are needed, especially when time information is expected to be included in the debug output, users may think that corresponding functions are not supported due to the lack of corresponding descriptions in the official documents.
So much so that I even made changes to the mysql code, and when I finished unit testing to modify the source file dbug.cc, I found that the functionality was already implemented in DoPrefix and the corresponding parameters were found in DbugParse.

How to repeat:
Please refer directly to 5.9.4 The DBUG Package
And the DbugParse/DoPrefix function for code dbug.cc

Suggested fix:
In 5.9.4 The DBUG Package documentation, add the missing A/a/T for the debug option so that users are aware of the relevant functionality.
[29 May 7:55] MySQL Verification Team
Hello xichao li,

Thank you for the report and feedback.

regards,
Umesh
[28 Jun 4:00] Philip Olson
Posted by developer:
 
Thank you for the bug report, the changes are now live:

https://dev.mysql.com/doc/refman/5.7/en/dbug-package.html
https://dev.mysql.com/doc/refman/8.0/en/dbug-package.html

Added:   a, A, and T.
Removed: S (it was removed in MySQL 5.5.6!)

Does it look good to you and/or can you think of improvements?
[28 Jun 5:49] xichao li
No. Very good.
Thank you for your feedback.
[29 Jun 14:06] Philip Olson
Posted by developer:
 
Thanks again xichao li, status->closed.