13.2.6 Doc Indexing

For efficient retrieval of docstrings from GDFv1 files (see Doc Snarfing Overview), you need to make an index of them using the make-twerp2texi-index program (see guile-tools make-twerp2texi-index). A typical Makefile.am fragment would be:

     DOT_DOC_FILES = foo.doc bar.doc sub/foo.doc sub/bar.doc ...
     .doc-index: $(DOT_DOC_FILES)
             guile-tools make-twerp2texi-index -o $@ $(DOT_DOC_FILES)

Note that we use DOT_DOC_FILES in the action of the rule instead of $^, as the latter is not entirely portable. Also, the index is customarily named .doc-index but that's not required.

As shown in the example, you can include GDFv1 files from subdirectories as well as the current directory. Avoid prefixes, however; the next step relies on the filenames to be relative (see Doc Insertion).