5.5.3 Checking cross-references

Cross-references between different manuals are heavily used in the documentation, but they do not cause errors during the compilation – the documentation generator, texi2any, only reports invalid cross-references within the same manual. However, if you compile the documentation, a script called check_texi_refs.py can help you with checking and fixing these cross-references.

To make this work properly you have to configure LilyPond for an in-tree build (see Running autogen.sh), followed by calling make and make doc.

Normally, you don’t call check_texi_refs.py by yourself; instead, two make targets are provided for this task. To call them, first change the current directory to the LilyPond source tree where the documentation was built, then enter the Documentation directory and run:

make check-xrefs
make fix-xrefs

Be careful with the second command since it can change documentation files without further asking.

In case you have to fix cross-references in generated documentation like the Internals Reference you must locate the corresponding source code files by yourself. Scan the directories scm/ for Scheme code and lily/ for C++ code. See Searching.