[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Section organization ]		[  Up : Documentation policy ]	[ General writing > ]

5.4.3 Checking cross-references

Cross-references between different manuals are heavily used in the documentation, but they are not checked during compilation. However, if you compile the documentation, a script called check_texi_refs can help you with checking and fixing these cross-references; for information on usage, cd into a source tree where documentation has been built, cd into Documentation and run:

make check-xrefs
make fix-xrefs

Note that you have to find yourself the source files to fix cross-references in the generated documentation such as the Internals Reference; e.g. you can grep scm/ and lily/.

Also of interest may be the linkdoc checks on kainhofer.com. Be warned that these docs are not completely rebuilt every day, so it might not accurately reflect the current state of the docs.

http://kainhofer.com/~lilypond/linkdoc/

---

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Section organization ]		[  Up : Documentation policy ]	[ General writing > ]

<< Back to Documentation Index

LilyPond — Contributor’s Guide v2.18.2 (stable-branch).