Fix dead links

Author: pitdicker

.travis.yml

@@ -34,6 +34,8 @@ matrix:
         - cargo test --features serde-1,log,nightly
         - cargo test --benches
         - cargo doc --no-deps --all --all-features
+        - cargo --list | egrep "^\s*deadlinks$" -q || cargo install cargo-deadlinks
+        - cargo deadlinks
       after_success:
         - travis-cargo --only nightly doc-upload
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rand"
-version = "0.5.0-pre.0"
+version = "0.5.0-pre.0" # NB: When modifying, also modify html_root_url in lib.rs
 authors = ["The Rust Project Developers"]
 license = "MIT/Apache-2.0"
 readme = "README.md"
@@ -29,7 +29,7 @@ serde-1 = ["serde", "serde_derive"] # enables serialisation for PRNGs
 members = ["rand_core"]
 
 [dependencies]
-rand_core = { version = '0.1.0-pre.0', default-features = false }
+rand_core = { path="rand_core", default-features = false }
 log = { version = "0.4", optional = true }
 serde = { version = "1", optional = true }
 serde_derive = { version = "1", optional = true }

rand_core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rand_core"
-version = "0.1.0-pre.0"
+version = "0.1.0-pre.0" # NB: When modifying, also modify html_root_url in lib.rs
 authors = ["The Rust Project Developers"]
 license = "MIT/Apache-2.0"
 readme = "README.md"

rand_core/src/lib.rs

@@ -83,8 +83,8 @@ pub mod le;
 /// output (except by communicating that the release has breaking changes).
 /// 
 /// Typically implementators will implement only one of the methods available
-/// in this trait directly, then use the helper functions from the [`impls`]
-/// module to implement the other methods.
+/// in this trait directly, then use the helper functions from the
+/// [`rand_core::impls`] module to implement the other methods.
 /// 
 /// It is recommended that implementations also implement:
 /// 
@@ -131,7 +131,7 @@ pub mod le;
 /// [rand]: https://crates.io/crates/rand
 /// [`Rng`]: ../rand/trait.Rng.html
 /// [`SeedableRng`]: trait.SeedableRng.html
-/// [`impls`]: impls/index.html
+/// [`rand_core::impls`]: ../rand_core/impls/index.html
 /// [`try_fill_bytes`]: trait.RngCore.html#tymethod.try_fill_bytes
 /// [`fill_bytes`]: trait.RngCore.html#tymethod.fill_bytes
 /// [`next_u32`]: trait.RngCore.html#tymethod.next_u32
@@ -143,23 +143,23 @@ pub trait RngCore {
     /// RNGs must implement at least one method from this trait directly. In
     /// the case this method is not implemented directly, it can be implemented
     /// using `self.next_u64() as u32` or
-    /// [via `fill_bytes`](impls/fn.next_u32_via_fill.html).
+    /// [via `fill_bytes`](../rand_core/impls/fn.next_u32_via_fill.html).
     fn next_u32(&mut self) -> u32;
 
     /// Return the next random `u64`.
     ///
     /// RNGs must implement at least one method from this trait directly. In
     /// the case this method is not implemented directly, it can be implemented
-    /// [via `next_u32`](impls/fn.next_u64_via_u32.html) or
-    /// [via `fill_bytes`](impls/fn.next_u64_via_fill.html).
+    /// [via `next_u32`](../rand_core/impls/fn.next_u64_via_u32.html) or
+    /// [via `fill_bytes`](../rand_core/impls/fn.next_u64_via_fill.html).
     fn next_u64(&mut self) -> u64;
 
     /// Fill `dest` with random data.
     ///
     /// RNGs must implement at least one method from this trait directly. In
     /// the case this method is not implemented directly, it can be implemented
-    /// [via `next_u32`](impls/fn.fill_bytes_via_u32.html) or
-    /// [via `next_u64`](impls/fn.fill_bytes_via_u64.html) or
+    /// [via `next_u32`](../rand_core/impls/fn.fill_bytes_via_u32.html) or
+    /// [via `next_u64`](../rand_core/impls/fn.fill_bytes_via_u64.html) or
     /// via `try_fill_bytes`; if this generator can fail the implementation
     /// must choose how best to handle errors here (e.g. panic with a
     /// descriptive message or log a warning and retry a few times).
@@ -329,7 +329,7 @@ pub trait SeedableRng: Sized {
     ///
     /// Seeding a small PRNG from another small PRNG is possible, but
     /// something to be careful with. An extreme example of how this can go
-    /// wrong is seeding an [`XorShiftRng`] from another [`XorShiftRng`], which
+    /// wrong is seeding an Xorshift RNG from another Xorshift RNG, which
     /// will effectively clone the generator. In general seeding from a
     /// generator which is hard to predict is probably okay.
     ///
@@ -338,7 +338,6 @@ pub trait SeedableRng: Sized {
     /// 
     /// [`NewRng`]: ../rand/trait.NewRng.html
     /// [`OsRng`]: ../rand/os/struct.OsRng.html
-    /// [`XorShiftRng`]: ../rand/struct.XorShiftRng.html
     fn from_rng<R: RngCore>(mut rng: R) -> Result<Self, Error> {
         let mut seed = Self::Seed::default();
         rng.try_fill_bytes(seed.as_mut())?;

src/jitter.rs

@@ -50,7 +50,7 @@ const MEMORY_SIZE: usize = MEMORY_BLOCKS * MEMORY_BLOCKSIZE;
 /// This implementation is based on
 /// [Jitterentropy](http://www.chronox.de/jent.html) version 2.1.0.
 ///
-/// [`OsRng`]: os/struct.OsRng.html
+/// [`OsRng`]: ../os/struct.OsRng.html
 pub struct JitterRng {
     data: u64, // Actual random number
     // Number of rounds to run the entropy collector per 64 bits
@@ -496,7 +496,7 @@ impl JitterRng {
     /// to collect 64 bits of entropy. Otherwise a [`TimerError`] with the cause
     /// of the failure will be returned.
     ///
-    /// [`TimerError`]: jitter/enum.TimerError.html
+    /// [`TimerError`]: enum.TimerError.html
     #[cfg(not(all(target_arch = "wasm32", not(target_os = "emscripten"))))]
     pub fn test_timer(&mut self) -> Result<u8, TimerError> {
         debug!("JitterRng: testing timer ...");

src/lib.rs

@@ -169,11 +169,11 @@
 //! [`SmallRng`]: struct.SmallRng.html
 //! [`ReseedingRng`]: reseeding/struct.ReseedingRng.html
 //! [`prng`]: prng/index.html
-//! [`IsaacRng::new_from_u64`]: struct.IsaacRng.html#method.new_from_u64
+//! [`IsaacRng::new_from_u64`]: prng/isaac/struct.IsaacRng.html#method.new_from_u64
 //! [`Hc128Rng`]: prng/hc128/struct.Hc128Rng.html
 //! [`ChaChaRng`]: prng/chacha/struct.ChaChaRng.html
-//! [`IsaacRng`]: prng/struct.IsaacRng.html
-//! [`Isaac64Rng`]: prng/struct.Isaac64Rng.html
+//! [`IsaacRng`]: prng/isaac/struct.IsaacRng.html
+//! [`Isaac64Rng`]: prng/isaac64/struct.Isaac64Rng.html
 //! [`seq`]: seq/index.html
 //! [`distributions`]: distributions/index.html
 //! [`Uniform`]: distributions/struct.Uniform.html

src/thread_rng.rs

@@ -93,7 +93,7 @@ thread_local!(
 /// [`ReseedingRng`]: reseeding/struct.ReseedingRng.html
 /// [`StdRng`]: struct.StdRng.html
 /// [`EntropyRng`]: struct.EntropyRng.html
-/// [HC-128]: struct.Hc128Rng.html
+/// [HC-128]: prng/hc128/struct.Hc128Rng.html
 pub fn thread_rng() -> ThreadRng {
     ThreadRng { rng: THREAD_RNG_KEY.with(|t| t.clone()) }
 }