Fix broken doc links (#1823)

Release 0.8.2. This is a point in favor of landing #1021
google · Oct 5, 2024 · 1271aa0 · 1271aa0
1 parent 7f2d45d
commit 1271aa0
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 20 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -15,7 +15,7 @@
 [package]
 edition = "2021"
 name = "zerocopy"
-version = "0.8.1"
+version = "0.8.2"
 authors = ["Joshua Liebow-Feeser <[email protected]>"]
 description = "Zerocopy makes zero-cost memory manipulation effortless. We write \"unsafe\" so you don't have to."
 categories = ["embedded", "encoding", "no-std::no-alloc", "parsing", "rust-patterns"]
@@ -77,13 +77,13 @@ std = ["alloc"]
 __internal_use_only_features_that_work_on_stable = ["alloc", "derive", "simd", "std"]
 
 [dependencies]
-zerocopy-derive = { version = "=0.8.1", path = "zerocopy-derive", optional = true }
+zerocopy-derive = { version = "=0.8.2", path = "zerocopy-derive", optional = true }
 
 # The "associated proc macro pattern" ensures that the versions of zerocopy and
 # zerocopy-derive remain equal, even if the 'derive' feature isn't used.
 # See: https://github.com/matklad/macro-dep-test
 [target.'cfg(any())'.dependencies]
-zerocopy-derive = { version = "=0.8.1", path = "zerocopy-derive" }
+zerocopy-derive = { version = "=0.8.2", path = "zerocopy-derive" }
 
 [dev-dependencies]
 itertools = "0.11"
@@ -97,6 +97,6 @@ testutil = { path = "testutil" }
 # CI test failures.
 trybuild = { version = "=1.0.89", features = ["diff"] }
 # In tests, unlike in production, zerocopy-derive is not optional
-zerocopy-derive = { version = "=0.8.1", path = "zerocopy-derive" }
+zerocopy-derive = { version = "=0.8.2", path = "zerocopy-derive" }
 # TODO(#381) Remove this dependency once we have our own layout gadgets.
 elain = "0.3.0"
diff --git a/src/lib.rs b/src/lib.rs
@@ -1357,7 +1357,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -1459,7 +1459,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -1545,7 +1545,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -1631,7 +1631,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -1739,7 +1739,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -1834,7 +1834,7 @@ pub unsafe trait TryFromBytes {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [slice-dst]: KnownLayout#dynamically-sized-types
     ///
@@ -3444,7 +3444,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -3528,7 +3528,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -3612,7 +3612,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -3680,7 +3680,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -3764,7 +3764,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -3849,7 +3849,7 @@ pub unsafe trait FromBytes: FromZeros {
     ///
     /// `Self` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [self-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types

diff --git a/src/ref.rs b/src/ref.rs
@@ -271,7 +271,7 @@ where
     ///
     /// `T` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [t-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -325,7 +325,7 @@ where
     ///
     /// `T` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [t-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types
@@ -390,7 +390,7 @@ where
     ///
     /// `T` may be a sized type, a slice, or a [slice DST][slice-dst].
     ///
-    /// [valid-size]: crate#what-is-a-valid-size
+    /// [valid-size]: crate::KnownLayout#what-is-a-valid-size
     /// [t-unaligned]: Unaligned
     /// [size-error-from]: error/struct.SizeError.html#method.from-1
     /// [slice-dst]: KnownLayout#dynamically-sized-types

diff --git a/zerocopy-derive/Cargo.toml b/zerocopy-derive/Cargo.toml
@@ -9,7 +9,7 @@
 [package]
 edition = "2021"
 name = "zerocopy-derive"
-version = "0.8.1"
+version = "0.8.2"
 authors = ["Joshua Liebow-Feeser <[email protected]>"]
 description = "Custom derive for traits from the zerocopy crate"
 license = "BSD-2-Clause OR Apache-2.0 OR MIT"