Skip to content

Commit d882f2d

Browse files
committed
Clarify support for basic FTS all backends; augment native FTS desc.
Link to FTS setup/explanation in admin_guide for SQLite. Add FTS support paragraph with link to admin_guide for PostgreSQL too.
1 parent d525710 commit d882f2d

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

doc/installation.txt

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -571,10 +571,16 @@ Choosing Your Backend
571571
---------------------
572572

573573
The actual storage of Roundup tracker information is handled by backends.
574-
There's several to choose from, each with benefits and limitations:
574+
575+
Roundup supports basic full text search (FTS) for all backends. Some
576+
backends support a faster native FTS. Also Roundup supports using
577+
whoosh or xapian for FTS.
578+
579+
There are several backends to choose from, each with benefits and
580+
limitations:
575581

576582
========== =========== ===== ==============================
577-
Name Speed Users Support
583+
Name Speed Users Support
578584
========== =========== ===== ==============================
579585
anydbm Slowest Few Always available
580586
sqlite Fastest Few Always available
@@ -603,7 +609,8 @@ mysql Fast Many Needs install/admin (MySQLdb_)
603609
Installed SQLite should be the latest version available (3.3.8 is known
604610
to work, 3.1.3 is known to have problems).
605611

606-
Roundup supports using sqlite's full text search capability. This
612+
Roundup supports using `SQLite's full text search capability
613+
<admin_guide.html#sqlite-details>`_. This
607614
can improve searching if you are not installing another indexer like
608615
xapian or whoosh. It works best with English text.
609616
**postgresql**
@@ -612,6 +619,12 @@ mysql Fast Many Needs install/admin (MySQLdb_)
612619
requirements. You must also configure
613620
the ``rdbms`` section of your tracker's ``config.ini``. It is recommended
614621
that you use at least version 2.8 of psycopg2.
622+
623+
Roundup supports using `postgresql's full text search
624+
capability
625+
<admin_guide.html#postgresql-info>`_. This
626+
can improve searching if you are not installing another indexer like
627+
xapian or whoosh. It can be tuned to work with different languages.
615628
**mysql**
616629
Backend for popular RDBMS MySQL. You must read `doc/mysql.txt`_ for
617630
additional installation steps and requirements. You must also

0 commit comments

Comments
 (0)