]> git.lizzy.rs Git - rust.git/commit
mk: Ensure docs have relative links to each other
authorAlex Crichton <alex@alexcrichton.com>
Mon, 9 Jun 2014 20:00:18 +0000 (13:00 -0700)
committerAlex Crichton <alex@alexcrichton.com>
Mon, 9 Jun 2014 20:00:18 +0000 (13:00 -0700)
commit992a2db1fc64987c0c68c66e74bff81468b6f7b8
tree4a471792974d319a74a731a4f4f4d2dbaa1bec5a
parente55f64f99726a44283211d91a702081fe4a1855b
mk: Ensure docs have relative links to each other

When generating documentation, rustdoc has the ability to generate relative
links within the current distribution of crates to one another. To do this, it
must recognize when a crate's documentation is in the same output directory. The
current threshold for "local documentation for crate X being available" is
whether the directory "doc/X" exists.

This change modifies the build system to have new dependencies for each
directory of upstream crates for a rustdoc invocation. This will ensure that
when building documentation that all the crates in the standard distribution are
guaranteed to have relative links to one another.

This change is prompted by guaranteeing that offline docs always work with one
another. Before this change, races could mean that some docs were built before
others, and hence may have http links when relative links would suffice.

Closes #14747
mk/docs.mk