Bug #54648 InnoDB Plugin installation page does not show how to install the plugin
Submitted: 21 Jun 2010 0:54 Modified: 8 Jul 2010 22:39
Reporter: Roel Van de Paar Email Updates:
Status: Not a Bug Impact on me:
None 
Category:MySQL Server: Documentation Severity:S4 (Feature request)
Version: OS:Any
Assigned to: Jon Stephens CPU Architecture:Any

[21 Jun 2010 0:54] Roel Van de Paar
Description:
http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-overview.html does not show how to actually install the plugin. (note that Linux and Windows installation may be different)

How to repeat:
See URL above
[21 Jun 2010 3:31] Giuseppe Maxia
The URL mentioned is just the overview.
The actual instructions, for Unix or Windows, are in the same chapter:

http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-dynamic.html
[21 Jun 2010 3:37] Roel Van de Paar
This seems hard to locate. Could we please add a link from:

http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation.html

To: 

http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-dynamic.html
[21 Jun 2010 3:49] Giuseppe Maxia
innodb plugin installation manual

Attachment: installing_innodb_plugin.png (image/png, text), 205.42 KiB.

[21 Jun 2010 3:51] Giuseppe Maxia
from this page
http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation.html

there are actually *two* links to the installation page.
http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-dynamic.html

See attached screen shot
[21 Jun 2010 3:55] Roel Van de Paar
My mistake. Could we please add a link from:

http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-overview.html

To:

http://dev.mysql.com/doc/innodb-plugin/1.0/en/innodb-plugin-installation-dynamic.html

It was not clear for the customer, nor was it for me. "Installing the Precompiled InnoDB Plugin as a Shared Library" does not look like a section to consult when there is a "Overview of Installing the InnoDB Plugin", unless the "as a Shared Library" is removed (even though that is how it's done).
[21 Jun 2010 6:51] Jon Stephens
This is not a bug.

Qualification != negation.

Car analogy: If a page of instructions is entitled "How to Wash a Car Using Soap, Water, and a Sponge", this does not imply that the page somehow does not 'really' provide instructions on washing your car.
[21 Jun 2010 6:56] Giuseppe Maxia
There are two cases:
a) the reader knows that a plugin is a shared library, and therefore the link mentioning a shared library won't come as a surprise.
b) the reader doesn't know what a plugin is. Then he/she will read the overview page, and learn that "we recommend you install the binary shared library for the InnoDB Plugin". Then the link mentioning a shared library won't be a surprise either.

Since there is a link from the overview page to the "install the plugin as a shared library" page, it is not a bug.
[21 Jun 2010 22:06] Roel Van de Paar
If we can make the manual better/easier to navigate by adding a link from the "installation overview page" to the "actual installation instructions" - let's do so. This will make it easier for both users and engineers to find. Not everyone may realize that the InnoDB plugin is installed "as a Shared Library".
[22 Jun 2010 1:12] Jon Stephens
The requested link is already present in the section navigation.
[22 Jun 2010 4:35] Roel Van de Paar
It is.

I maintain however that "Overview of Installing the InnoDB Plugin" should link to the actual installation instructions of the plugin, from the document, using a link similar to this: "Install the InnoDB Plugin" or "Installing the InnoDB Plugin" - not from a sidebar with a link which is formulated as "Installing the *Precompiled* InnoDB Plugin *as a Shared Library*" which is counter-intuitive.

And, as mentioned, there is a customer and two engineers who have not been able to locate the needed information immediately.