MySQL Bugs: #83142: Documentation clarifications about how default option files are used

Bug #83142	Documentation clarifications about how default option files are used
Submitted:	25 Sep 2016 18:38	Modified:	11 Feb 2017 14:38
Reporter:	John Fawcett	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:	5.7.15	OS:	Any
Assigned to:		CPU Architecture:	Any
Tags:	libmysql C API option files

Description:
CHANGE #1

http://dev.mysql.com/doc/refman/5.7/en/option-files.html

Where this page states

"The [client] option group is read by all client programs."

I suggest to ammend to:

"The [client] option group is read by all MySQL provided client programs. (To understand how the options files are used with client programs that use the C API please refer to the C API documentation http://dev.mysql.com/doc/refman/5.7/en/mysql-options.html)"

CHANGE #2

http://dev.mysql.com/doc/refman/5.7/en/mysql-options.html

Where this page states:

"The client group is always read if you use MYSQL_READ_DEFAULT_FILE or MYSQL_READ_DEFAULT_GROUP. "

I suggest to change to:

The client group is always read if you use MYSQL_READ_DEFAULT_FILE or MYSQL_READ_DEFAULT_GROUP. If neither option is specified then no default configuration is read at all. If you require that the client group be read from the default configuration file then specify a value of "client" for the option MYSQL_READ_DEFAULT_GROUP."

How to repeat:
Documentation only

Suggested fix:
See above

Thank you for the bug report.

Posted by developer:
 
Change #1 added, thank you.

Change #2 not added. Not using MYSQL_READ_DEFAULT_FILE or MYSQL_READ_DEFAULT_GROUP does not prevent client programs from reading option files. Client programs in MySQL distributions typically use neither option but still read option files.