Bug #47015 Suggested "slow query log" manual page updates

• Submitted: 31 Aug 2009 11:45
• Modified: 9 Sep 2009 17:51
• Reporter: Roger David Nay
• Status: Closed
• Category: MySQL Server: Documentation
• Severity: S3 (Non-critical)
• OS: Any
• Assigned to: Paul DuBois
• CPU Architecture: Any

[31 Aug 2009 11:45] Roger David Nay

Description:
Slow query log changes, confusing in manual. 1 and 3 are suggestions, I think 2 is an error.

http://dev.mysql.com/doc/refman/5.1/en/slow-query-log.html

How to repeat:
N/A

Suggested fix:
1. "Use --slow_query_log to enable the slow query log, and optionally --slow_query_log_file=file_name to specify a log file name. --slow_query_log takes an optional argument of 1 or 0 to enable or disable the log."

How about...

"Use --slow_query_log to enable the slow query log, this option takes an argument of 1 or 0 to enable or disable the log, and optionally use --slow_query_log_file=[file_name] to specify a log file name."

2. "Set general_log_file to specify the name of the log file. If a log file already is open, it is closed and the new file is opened."

Should be...

"Set slow_query_log_file to specify the name of the log file. If a log file already is open, it is closed and the new file is opened."

3. Move this to near the end, as in the middle of the page it seems confusing (and a minor change)...
When --log-slow-queries is specified, --slow_query_log also may be given as of MySQL 5.1.12 to specify the initial slow query log state. With no argument or an argument of 0, the option disables the log. If omitted or given with an argument of 1, the option enables the log.

Add [=filename]...

When --log-slow-queries[=file_name] is specified, --slow_query_log also may be given as of MySQL 5.1.12 to specify the initial slow query log state. With no argument or an argument of 0, the option disables the log. If omitted or given with an argument of 1, the option enables the log.

[3 Sep 2009 17:23] Paul DuBois

2) is indeed an error, I'll fix that.

[9 Sep 2009 17:51] Paul DuBois

Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly, and will be included in the next release of the relevant products.

* Corrected the reference to general_log_file that should be slow_query_log_file.

* Collected the various version-specific statements about correcting the log into a list, ordered by version.

* Corrected the 5.1.12 description (--slow_query_log is an alternative, not an adjunct, to --log-slow-queries).