266461 - Minimum requirements for ft_min_word_len MySQL parameter should be documented

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Leigh Hunt]

User-Agent:       Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0; .NET CLR 1.1.4322)
Build Identifier: 

It may be worth highlighting that the ft_min_word_len parameter is only 
available as of MySQL 4.0.0.

The MySQL subsection in the Installation section of the documentation states:
"You need MySQL version 3.23.41 or higher.", impying it will work with this 
version of mysql.

(P.S. I originally appended this comment to bug 218206, but was unable to re-
open it.)

Reproducible: Always
Steps to Reproduce:
1. In /etc/my.cnf, specify:
   ft_min_word_len = 3
2. When attempting to restart MySQL (version <4), you will get an error, and 
mysql will not start.


Actual Results:  
This feature is not supported until mysql v4.
Contents of /var/log/mysqld.log:

start of extract -->
041028 14:52:31  mysqld started
/usr/libexec/mysqld: unrecognized option `--ft_min_word_len=3'
/usr/libexec/mysqld  Ver 3.23.58 for redhat-linux-gnu on i386
Copyright (C) 2000 MySQL AB, by Monty and others
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL license
Starts the MySQL server

Usage: /usr/libexec/mysqld [OPTIONS]
...
...
<-- end of extract

Expected Results:  
Whilst the documentation does for this feature (Allow small words in full-text 
indexes) *does* point the user towards the page 
http://www.mysql.com/doc/en/Fulltext_Fine-tuning.html, it is not immediately 
obvious what has gone wrong.

Granted it is in the relevant log files, but a little note stating that this 
isn't supported below v4 of mysql could be useful, and may save some time.

Comment 1

[Leigh Hunt]

Adding relationship to previous bug - 218206

Comment 2

[Dave Miller [:justdave]]

This can't block 218206 because it's already resolved.  Making it depend instead. :)

Comment 3

[Shane H. W. Travis]

Attachment: documentation patch for 2.18 and tip

Comment 4

[Shane H. W. Travis]

Comment on attachment 164224 [details] [diff] [review]
documentation patch for 2.18 and tip

Add a warning to documentation for 2.18 and tip that you need to have MySQL v4
or better to use this feature.

Comment 5

[Vlad Dascalu]

Comment on attachment 164224 [details] [diff] [review]
documentation patch for 2.18 and tip

We should use the <note> Docbook tag, see
http://developers.cogentrts.com/cogent/prepdoc/pd-admonitions.html for details.

Comment 6

[Vlad Dascalu]

Attachment: v2

Comment 7

[Vlad Dascalu]

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.78; previous revision: 1.77
done

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.72.2.6; previous revision: 1.72.2.5
done