en/LXR 2.4 Populate Database

It is time to generate the index. This is a job for script genxref. genxref is driven by two or three arguments:

--url=URL_of_your_source_tree
The URL is made of a 'host_names' followed by 'virtroot'.
The purpose of this argument is to locate inside lxr.conf which tree to work on (at least the server if the tree name comes from an URL argument).

--tree=name_of_tree_to_index
(Starting with LXR 2.0) This selects a tree if it must be designated through an URL argument.

--version=name_of_version_to_index
This instructs genxref to index only the designated version. It is interesting for trees with numerous versions to limit the time spent in indexing when only one version was modified since last indexing.
The version must match one defined in the 'range' parameter.

With the previous configuration, this gives:

$ ./genxref --url=http://localhost/lxr --version=v1

Depending on the size of your source, indexing may be very lengthy. If you intend to index the kernel tree, think of launching genxref for at least an overnight job (YMMV). Test before on a simple case if this is your first installation.

As an example, indexing the single 3.1 kernel with LXR 1.0 took 2 hours 39 minutes on a high-end computer (Intel i5 3.3GHz processor and 4GB memory under Fedora 17, MySQL and Glimpse). This time drops slightly below one hour with LXR 2.0 on the same carefully tuned computer.

Before launching this time-consuming job, you have a last opportunity to check your configuration for trivial errors with option --checkonly:

$ ./genxref --url=http://localhost/lxr --version=v4 --checkonly [ OK ] Perl version ... 5.14.2 [ OK ] ctags version ... 5.8 Checked: glimpse version ... 4.18.5 Checked: glimpseindex version ... 4.18.5 Parameter 'swishbin' not defined - trying to find swish-e swish-e not found, `command -v swish-e` returned a null string genxref stopped without indexing by --checkonly option Of course, not all errors are found, but this test eliminates typo errors on critical parameters.

You can also ask genxref to index every version in your tree with option --allversions as in:

$ ./genxref --url=http://localhost/lxr --allversions