Step 5: Populate LXR Database

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

• --url=URL_of_your_source_tree

  The URL may be any defined in 'baseurl' or 'baseurl_alias' or the catenation of one 'host_names' followed by 'virtroot'.
  The purpose of this argument is to locate inside lxr.conf which tree to work on.

• --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 consumed 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:

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.

• Version 0.10 and higher

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

  $ ./genxref --url=http://localhost/lxr --version=v4 --checkonly Checking Perl version ... 5.14.2 OK Checking ctags version ... 5.8 OK Checking glimpse version ... 4.18.5 Parameter 'swishbin' not defined - trying to find swish-e swish-e not found, `which 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 the critical parameters.

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