rust: sync: improve `Arc` documentation links
PATCH v2 1/1 rust: sync: improve `Arc` documentation links
The Arc documentation has a few mentions that do not follow the surrounding style: a plain Arc without an intra-doc link and a lower-case "arc".
Use intra-doc links for rustdoc references to Arc and spell internal comments consistently as Arc, matching nearby docs.
Suggested-by Miguel Ojeda <[email protected]>
Signed-off-by Harish C S <[email protected]>
---
Changes in v2:
- Use full name in the patch author and Signed-off-by trailer.
rust/kernel/sync/arc.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
rust/kernel/sync/arc.rs +6 -6
@@ -154,7 +154,7 @@ impl<T: ?Sized> ArcInner<T> {/// /// # Safety /// -/// `ptr` must have been returned by a previous call to [`Arc::into_raw`], and the `Arc` must +/// `ptr` must have been returned by a previous call to [`Arc::into_raw`], and the [`Arc`] must /// not yet have been destroyed. unsafe fn container_of (ptr: *const T ) ->NonNull <ArcInner <T >> {let refcount_layout =Layout ::new ::<Refcount >();
@@ -253,7 +253,7 @@ unsafe fn from_inner(inner: NonNull<ArcInner<T>>) -> Self {/// Convert the [`Arc`] into a raw pointer. /// -/// The raw pointer has ownership of the refcount that this Arc object owned. +/// The raw pointer has ownership of the refcount that this [`Arc`] object owned. pub fn into_raw (self) -> *const T {let ptr = self.ptr.as_ptr (); core::mem::forget (self);
@@ -261,7 +261,7 @@ pub fn into_raw(self) -> *const T {unsafe { core::ptr::addr_of!((*ptr).data) } } -/// Return a raw pointer to the data in this arc. +/// Return a raw pointer to the data in this [`Arc`]. pub fn as_ptr (this: &Self ) -> *const T {let ptr = this.ptr.as_ptr ();
@@ -305,7 +305,7 @@ pub fn ptr_eq(this: &Self, other: &Self) -> bool {/// Converts this [`Arc`] into a [`UniqueArc`], or destroys it if it is not unique. /// -/// When this destroys the `Arc`, it does so while properly avoiding races. This means that +/// When this destroys the [`Arc`], it does so while properly avoiding races. This means that /// this method will never call the destructor of the value. /// /// # Examples
@@ -345,11 +345,11 @@ pub fn into_unique_or_drop(this: Self) -> Option<Pin<UniqueArc<T>>> {// If the refcount reaches a non-zero value, then we have destroyed this `Arc` and will // return without further touching the `Arc`. If the refcount reaches zero, then there are -// no other arcs, and we can create a `UniqueArc`. +// no other `Arc`s, and we can create a `UniqueArc`. if refcount.dec_and_test () { refcount.set (1 ); -// INVARIANT: We own the only refcount to this arc, so we may create a `UniqueArc`. We +// INVARIANT: We own the only refcount to this `Arc`, so we may create a `UniqueArc`. We // must pin the `UniqueArc` because the values was previously in an `Arc`, and they pin // their values. Some(Pin::from(UniqueArc {
Signature · 1 line
2.50.1 (Apple Git-155)