Bug #23722 Suggestion for documentation: re-organize EXPLAIN docs
Submitted: 27 Oct 2006 15:14 Modified: 27 Oct 2006 19:44
Reporter: Baron Schwartz (Basic Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:All OS:Any (All)
Assigned to: Paul DuBois CPU Architecture:Any

[27 Oct 2006 15:14] Baron Schwartz
Description:
The documentation for EXPLAIN says

"If you want to make your queries as fast as possible, you should look out for Extra values of Using filesort and Using temporary."

This is good advice, but it is under the sub-heading of 'Using where'.  It doesn't make sense to me that it is there.  No-one will notice it there.

See http://dev.mysql.com/doc/refman/5.0/en/explain.html

How to repeat:
See http://dev.mysql.com/doc/refman/5.0/en/explain.html

Suggested fix:
That section may be clearer and more noticable if it is in the general discussion.
[27 Oct 2006 15:24] Paul DuBois
I think this happened when Using where was the last
item in the list. After that, a number of other list items
were added around it and the statement in question
got buried.  It's a good suggestion to move it.
[27 Oct 2006 19:44] 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.

I moved the para in question to the text that introduces the
list of items.