Bug #88208 CLIENT_OPTIONAL_RESULTSET_METADATA is defined in wrong place

• Submitted: 24 Oct 2017 16:56
• Modified: 25 Oct 2017 10:51
• Reporter: Bradley Grainger (OCA)
• Status: Verified
• Category: MySQL Server: DDL
• Severity: S3 (Non-critical)
• Version: 8.0
• OS: Any
• CPU Architecture: Any
• Tags: documentation

[24 Oct 2017 16:56] Bradley Grainger

Description:
The comment for and definition of CLIENT_OPTIONAL_RESULTSET_METADATA (at 
https://github.com/mysql/mysql-server/blob/020025d9f277fd3283b8c75024f590857f58fbbd/includ...) is inserted between the comment for CLIENT_SSL_VERIFY_SERVER_CERT and its definition: https://github.com/mysql/mysql-server/blob/020025d9f277fd3283b8c75024f590857f58fbbd/includ...

As a result, the generated documentation for CLIENT_OPTIONAL_RESULTSET_METADATA and CLIENT_SSL_VERIFY_SERVER_CERT is incorrect:
* https://dev.mysql.com/doc/dev/mysql-server/latest/group__group__cs__capabilities__flags.ht...
* https://dev.mysql.com/doc/dev/mysql-server/latest/group__group__cs__capabilities__flags.ht...

How to repeat:
Open mysql_com.h in a text editor and go to line 618

https://github.com/mysql/mysql-server/blob/020025d9f277fd3283b8c75024f590857f58fbbd/includ...

Suggested fix:
Rewrite lines 618-633 as follows:

/**
  Verify server certificate.
  Client only flag.
  @deprecated in favor of --ssl-mode.
*/
#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)

/**
  The client can handle optional metadata information in the resultset.
*/
#define CLIENT_OPTIONAL_RESULTSET_METADATA (1UL << 25)

[24 Oct 2017 17:05] Bradley Grainger

Opened a PR to fix this problem: https://github.com/mysql/mysql-server/pull/175

[25 Oct 2017 10:49] MySQL Verification Team

Thank you for the bug report.