wiki:RepoSearchPlugin

Version 19 (modified by anonymous, 7 years ago) (diff)

Added trac.ini setup instructions

Plugin for searching the source repository

Description

This plugin allows users to search the source repository.

Installation

To use the repository search, users must have the REPO_SEARCH permission. Add this with trac-admin and off you go.

Depending on how you do the install, you may need to add a line to your trac.ini:

[components]
tracreposearch.* = enabled

and then reload your web server's configuration.

You can include and exclude parts of the repository by adding the following options to trac.ini:

[repo-search]
include = *.py:*.txt
exclude = *.pyc:*.png:*.jpg:*.gif:*/README

The globs are separated by your operating systems path separator (: under UNIX, ; under Windows) and each glob is matched against the full path. Hence */README instead of just README.

If only include is specified the default is to exclude all other files.

To speed up searches, an indexer is included. A full index will occur the first time you search the repository, which can take quite some time. Subsequent changesets will be incrementally indexed and should be pretty snappy.

The indexer is enabled by default and will use the PYTHON_EGG_CACHE dir to store its data. You can override this location by adding the following entry to your trac.ini:

[repo-search]
index = /my/trac/env/idx

The index option is a a directory that must be writable by the web server user.

The indexer should cope with changes to the include/exclude lists. Newly included files will be indexed, and newly excluded files will be removed from the word:file mapping table.

Note: Under Win32 you will need this module in order for the indexer to work.

Bugs/Feature Requests

Existing bugs and feature requests for RepoSearchPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Note: the version for 0.10 contains performance enhancements not back ported to the 0.9 version.

Source

You can check out RepoSearchPlugin from here using Subversion, or browse the source with Trac.

Recent Changes

[9664] by rjollos on 2010-12-12 07:43:46
Removing pydev project file that was accidentally checked-in.
[9663] by rjollos on 2010-12-12 07:39:18
Use \S in the regular expression that extracts words. \S will match any non-whitespace character, whereas \w only matches alphanumeric characters and the underscore. Refs #5938.
[8523] by rjollos on 2010-08-30 07:34:48
Fixed problem with indexing non-ascii characters. Fixes #2143.

Author/Contributors

Author: athomas
Contributors:

TagIt(plugin,athomas,0.9)?