MySQL Bugs: #58111: English docs for EXPLAIN are broken

Bug #58111	English docs for EXPLAIN are broken
Submitted:	10 Nov 2010 12:53	Modified:	19 Nov 2010 15:31
Reporter:	Susanne Ebrecht	Email Updates:
Status:	Not a Bug	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S1 (Critical)
Version:	5.1	OS:	Any
Assigned to:	Paul DuBois	CPU Architecture:	Any

Description:
You don't need to understand German to figure out that EXPLAIN is explained here really good:

http://dev.mysql.com/doc/refman/5.1/de/explain.html

Now look to the English pendant:
http://dev.mysql.com/doc/refman/5.1/en/explain.html

It is much shorter ...

Additionally, click onto the link in the english page -> EXPLAIN EXTENDED

You will get again:
http://dev.mysql.com/doc/refman/5.1/en/explain.html (looks like a loop)

Also when you click onto EXPLAIN PARTITIONS you just will get this page again.

Btw. I wasn't able to find the English pendant for the German EXPLAIN manual yet. And I could need English explanation for EXPLAIN output.

How to repeat:
See above

"Additionally, click onto the link in the english page -> EXPLAIN EXTENDED

You will get again:
http://dev.mysql.com/doc/refman/5.1/en/explain.html (looks like a loop)"

This is by intent. We try to link statement keywords to the section with the closest section ID.
For example, if you go to http://dev.mysql.com/doc/refman/5.5/en/select.html you will
see that instances of SELECT are links to the same section.

"Now look to the English pendant:
http://dev.mysql.com/doc/refman/5.1/en/explain.html

It is much shorter ..."

It's shorter because the English manual has had some reorganization. The EXPLAIN section now says: "For information regarding the use of EXPLAIN and EXPLAIN EXTENDED for obtaining query execution plan information, see Section 7.2.1, “Optimizing Queries with EXPLAIN”." That is where the main bulk of the material will be found.

I did a little minor reorganization within the page, but the page differs from the German for reasons explained previously.