check-req-xrefs

Overview ¶

check-req-xrefs verifies that references to requirements documents correctly quote their source, so we can ensure that implementations do not drift from the requirements they are implementing.

All cross-references are of the form:

// https://github.com/<org>/<repo>/blob/<ref>/path/to/doc.md?plain=1#L<num>
// Exact quote of the linked-to line of the document.

The tool requires network access to fetch the referenced document. It ensures that the following quoted line is correct, modulo trailing whitespace. It does not check whether the URL points to the latest version of the quoted document.

It exits with a nonzero status and a report of every discrepancy if any cross-reference is broken.