wiki:RepoSearchPlugin

Version 10 (modified by athomas, 9 years ago) (diff)

Note about using PYTHON_EGG_CACHE for index

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.

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 seperator (: under UNIX) 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 quite fast.

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.

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.

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)?