Skip to content

Commit

Permalink
rust/kernel/traits: fix rustdoc warnings
Browse files Browse the repository at this point in the history
A previous commit (Rust-for-Linux#292) introduced rustdoc warnings.
Fix rustdoc links to eliminate these warnings.

Remove mention of `Rc`, as it's not currently used anywhere in the
Rust kernel code.

Signed-off-by: Sven Van Asbroeck <thesven73@gmail.com>
  • Loading branch information
Sven Van Asbroeck committed May 28, 2021
1 parent 698569d commit f4f353b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion rust/kernel/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use alloc::{alloc::AllocError, sync::Arc};

/// Trait which provides a fallible version of `pin()` for pointer types.
///
/// Common pointer types which implement a `pin()` method include [`Box`], [`Arc`] and [`Rc`].
/// Common pointer types which implement a `pin()` method include [`Box`](alloc::boxed::Box) and [`Arc`].
pub trait TryPin<P: Deref> {
/// Constructs a new `Pin<pointer<T>>`. If `T` does not implement [`Unpin`], then data
/// will be pinned in memory and unable to be moved. An error will be returned
Expand Down

0 comments on commit f4f353b

Please sign in to comment.