This documentation relates to an earlier version of FishEye.
View

Unknown macro: {spacejump}

or visit the current documentation home.

By default, FishEye will cache and index your whole repository, and present all of this information to users. You can control what parts of your repository FishEye will access, by setting the 'Allow (Process)' repository option.

インクルード

The 'Includes' subsection defines what subtrees of your repository FishEye will index. FishEye defaults to including 'everything'. If you specify some 'include' directories, then FishEye will process only those directories (and all their subdirectories). For instance, you might want to do this to limit FishEye to the subset of active projects in your repository. Each include specifies the path to a subtree to be processed. Paths are expressed relative to the repository root configured in the repository configuration.

(info) By default Includes are case sensitive but they can be configured to be case-insensitive. If your repository is set to be case insensitive (Perforce) then Includes will also be case insensitive regardless of how the individual Includes are configured.
Examples:

  • Including directories:
    PROJECT1
    
    The code above includes /PROJECT1 and all its children (sub-directories and their contents). You could specify /PROJECT1/ and /PROJECT2/ to include both of these directories in FishEye's indexing.
Excludes

The 'Excludes' subsection allows you to specifically exclude files and directories from those which have been included in indexing. FishEye will not process these files and directories. Each exclude is an Antglob Pattern. Examples:

  • Excluding directories:
    /PROJECT2/
    
    The code above excludes /PROJECT2 and all its children (sub-directories and their contents).

  • Excluding file types:
    **/*.OBJ
    
    The code above excludes any OBJ (object) files.

    Changes to Includes and Excludes do not take effect until the repository is restarted. If you do not re-index when changing the includes and excluded, files and directories which have been indexed prior to the update will remain visible in FishEye.

Include/Exclude Processing

When processing includes and excluded, FishEye merges the includes and excludes from the repository itself with those from the repository defaults. The repository's specific includes and excludes take priority over those of the repository defaults. Once merged, FishEye processes include definitions first and then excludes. If there are any includes defined a path must match at least one of those includes to be considered. If there are no include patterns defined, all paths are considered to be included. Once includes have been processed, a path which is a candidate for processing is tested against any defined excludes. If the path matches any of the exclude patterns, the path is excluded and not included in FishEye.

(info) Includes do not support Antglobs. They are also defined relative to where FishEye connects to your repository. To match the 'tags' subtree, simply use /tags. Please note that Excludes can still make use of Antglobs.

About Setting the Repository Root

When you are setting the Allow (Process), you should be aware that the options on this page only act on the parts of the repository that lie under the level of the repository root, which you configure as a directory location in your repository. In other words, FishEye can only access directories "lower" than the repository root. For example, consider a repository with the following structure:

/CORE/2007/LEGACY/
/CORE/2008/PROJECT1/
/CORE/2008/PROJECT2/

In this case, you could set the repository root (or 'Path') to be /CORE/2008/. In that situation, you would be able to include or exclude the /PROJECT1/ and /PROJECT2/ directories, but the /CORE/2007/LEGACY/ directory would not be available. To have FishEye index all of the directories in this repository, you would need to set the repository root path to be /CORE/. Then, you could use the includes and excludes to add and remove directories under /CORE/ from FishEye's scan. For more information, see the Subversion configuration page and read the 'Path' options.