issue2550743 - Reindex with MySQL Server failed. It looks like

indexing large documents may require increasing mysql's
max_allowed_packet setting. Documented the issue in doc/mysql.txt.

Author: rouilj

CHANGES.txt

@@ -245,7 +245,7 @@ Fixed:
   Diagnosis and fix with patch by R David Murray. Support for
   restoring retired but active queries, html layout changes and doc
   by John Rouillard.
-- issue2550785: Using login from search (or logout) fails.  when
+- issue2550785: Using login from search (or logout) fails.  When
   logging in from a search page or after a logout it fails with an
   error. These failures have been fixed. The fix also keeps the user
   on the same page they started from before the login. There are two
@@ -258,6 +258,12 @@ Fixed:
   the simple dropdown search item, retired values are now removed from
   the expression editor. (We have an open question as to whether this
   is desirable.)
+- issue2550743 - Reindex with MySQL Server failed. It looks like
+  indexing large documents may require increasing mysql's
+  max_allowed_packet setting. Documented the issue in doc/mysql.txt.
+  Possible solutions include: increasing value of MySQL parameter,
+  changing the full text search engine to whoosh or xapian. Problem
+  report by telsch. Analysis/doc by John Rouillard.
 
 2016-01-11: 1.5.1
 

doc/mysql.txt

@@ -18,6 +18,33 @@ to install:
    ``roundup/backends/back_mysql.py`` file to enable DBD instead of InnoDB.
 2. Python MySQL interface - http://sourceforge.net/projects/mysql-python
 
+
+Other Configuration
+===================
+
+If you are indexing large documents (e.g attached file contents)
+using MySQL, you may need to increase the max_allowed_packet size.
+If you don't you can see the error::
+
+   'MySql Server has gone away (2006)'
+
+To do this edit /etc/my.conf and change::
+
+    [mysqld]
+    max_allowed_packet = 1M
+
+the 'max_allowed_packet' value from '1M' to '64M' or
+larger.
+
+Alternatively you can install an alternate indexer (whoosh, xapian
+etc.) and force the tracker to use it by setting the ``indexer``
+setting in the tracker's ``config.ini``.
+
+This fix was supplied by telsch. See issue
+http://issues.roundup-tracker.org/issue2550743 for further info or if
+you are interested in developing a patch to roundup to help work
+around this issue.
+
 Running the MySQL tests
 =======================