Commit cd16c41f authored by Valentin Obst's avatar Valentin Obst Committed by Miguel Ojeda
Browse files

rust: kernel: remove unneeded doclink targets 



Remove explicit targets for doclinks in cases where rustdoc can
determine the correct target by itself. The goal is to reduce unneeded
verbosity in the source code.

Signed-off-by: default avatarValentin Obst <kernel@valentinobst.de>
Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
Reviewed-by: default avatarMartin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-11-0c8af94ed7de@valentinobst.de


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 4c799d1d

rust/kernel/workqueue.rs

+0 −10
Original line number Diff line number Diff line
@@ -426,13 +426,10 @@ pub unsafe fn raw_get(ptr: *const Self) -> *mut bindings::work_struct { 
/// The [`OFFSET`] constant must be the offset of a field in `Self` of type [`Work<T, ID>`]. The

/// methods on this trait must have exactly the behavior that the definitions given below have.

///

/// [`Work<T, ID>`]: Work

/// [`impl_has_work!`]: crate::impl_has_work

/// [`OFFSET`]: HasWork::OFFSET

pub unsafe trait HasWork<T, const ID: u64 = 0> {

    /// The offset of the [`Work<T, ID>`] field.

    ///

    /// [`Work<T, ID>`]: Work

    const OFFSET: usize;



    /// Returns the offset of the [`Work<T, ID>`] field.
@@ -440,7 +437,6 @@ pub unsafe trait HasWork<T, const ID: u64 = 0> { 
    /// This method exists because the [`OFFSET`] constant cannot be accessed if the type is not

    /// [`Sized`].

    ///

    /// [`Work<T, ID>`]: Work

    /// [`OFFSET`]: HasWork::OFFSET

    #[inline]

    fn get_work_offset(&self) -> usize {
@@ -452,8 +448,6 @@ fn get_work_offset(&self) -> usize { 
    /// # Safety

    ///

    /// The provided pointer must point at a valid struct of type `Self`.

    ///

    /// [`Work<T, ID>`]: Work

    #[inline]

    unsafe fn raw_get_work(ptr: *mut Self) -> *mut Work<T, ID> {

        // SAFETY: The caller promises that the pointer is valid.
@@ -465,8 +459,6 @@ unsafe fn raw_get_work(ptr: *mut Self) -> *mut Work<T, ID> { 
    /// # Safety

    ///

    /// The pointer must point at a [`Work<T, ID>`] field in a struct of type `Self`.

    ///

    /// [`Work<T, ID>`]: Work

    #[inline]

    unsafe fn work_container_of(ptr: *mut Work<T, ID>) -> *mut Self

    where
@@ -495,8 +487,6 @@ unsafe fn work_container_of(ptr: *mut Work<T, ID>) -> *mut Self 
///     impl HasWork<MyStruct, 17> for MyStruct { self.work_field }

/// }

/// ```

///

/// [`HasWork<T, ID>`]: HasWork

#[macro_export]

macro_rules! impl_has_work {

    ($(impl$(<$($implarg:ident),*>)?