en/LXR lxr.conf Hiding Subdirectories or Files

Subdirectories

Some directories in your tree may not contain information relevant to your project. In this case, it may be worth considering to prevent LXR from seeing them, so that analysis of your tree is not cluttered by service data (like VCS auxiliary directories, binary objects created by your integrated development environment, etc.)

You can do it very easily with the 'ignoredirs' configuration parameter.

, 'ignoredirs' => [ directories ]

In fact, you do not really list directories, but partial paths.

If any directory (considered surrounded by path separators , i.e. / under Linux) matches a subdirectory in the file path, the file path is discarded by LXR.

Example:

, 'ignoredirs' => [ 'CVSROOT', '.git' ]

Release 1.1 and higher
Should you need a finer-grained control on directory exclusion, parameter 'filterdirs' operates on the full LXR path (rooted at 'virtroot'):
, 'filterdirs' => [ regular_expressions ]
By convention for this test, directory paths begin with a separator (/) and are NOT terminated by a separator.

Regular expressions are used one after the other in the order in which they are specified until a match (in which case the directory is excluded).

Usage of this parameter is strongly discouraged because of the processing time needed. Read the User's Manual for further explanation and examples.

Files

Similarly, some files intermixed with the real source files are not meaningful: compiler intermediate text-files (such as .moc files), "to do" reminders, binary output modules, etc.

These files can be discarded with the 'ignorefiles' configuration parameter.

, 'ignorefiles' => 'regexp'

The regular expression is applied on every file name in the directory. If it matches, the file is discarded.

Example:

LXR uses the following pattern to leave aside "invisible" files (the so-called "dot" files), editor backups, binary files and core dumps.

, 'ignorefiles' => '^\\.|~$|\\.(o|a|orig)$|^core$' Pay special attention to the double backslash (\) needed because of Perl's eval.

CAUTION!
Indiscriminate use of this parameter may cause total wipeout!

Notes:

When you override this parameter in a tree section, do not forget to merge the internal exclusion rule above with your specific rule.
When developing under CVS, you may have both source files and CVS delta databases in the same directory. To protect your "plain files" tree from garbage, you may exclude CVS files with pattern ,v$.
With a CVS tree, filename match does not consider suffix ,v. Consequently, the previous ,v$ pattern does not wipe out the whole tree.

Release 1.1 and higher
Should you need a more precise screening rule, parameter 'filterfiles' operates on the full LXR path (rooted at 'virtroot'):
, 'filterfiles' => [ regular_expressions ]
By convention for this test, file paths begin with a separator (/).

Regular expressions are used one after the other in the order in which they are specified until a match (in which case the file is excluded).

Usage of this parameter is also strongly discouraged because of the processing time needed. Read the User's Manual for further explanation and examples.