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

rust: kernel: mark code fragments in docs with backticks 



Fix places where comments include code fragments that are not enclosed
in backticks.

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-8-0c8af94ed7de@valentinobst.de


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

rust/kernel/ioctl.rs

+1 −1
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0



//! ioctl() number definitions.

//! `ioctl()` number definitions.

//!

//! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)

rust/kernel/sync/lock.rs

+1 −1
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ pub unsafe trait Backend { 
    /// The state required by the lock.

    type State;



    /// The state required to be kept between lock and unlock.

    /// The state required to be kept between `lock` and `unlock`.

    type GuardState;



    /// Initialises the lock.

rust/kernel/task.rs

+1 −1
Original line number Diff line number Diff line
@@ -132,7 +132,7 @@ fn deref(&self) -> &Self::Target { 
    /// Returns the group leader of the given task.

    pub fn group_leader(&self) -> &Task {

        // SAFETY: By the type invariant, we know that `self.0` is a valid task. Valid tasks always

        // have a valid group_leader.

        // have a valid `group_leader`.

        let ptr = unsafe { *ptr::addr_of!((*self.0.get()).group_leader) };



        // SAFETY: The lifetime of the returned task reference is tied to the lifetime of `self`,

rust/kernel/workqueue.rs

+5 −4
Original line number Diff line number Diff line
@@ -168,7 +168,7 @@ impl Queue { 
    /// # Safety

    ///

    /// The caller must ensure that the provided raw pointer is not dangling, that it points at a

    /// valid workqueue, and that it remains valid until the end of 'a.

    /// valid workqueue, and that it remains valid until the end of `'a`.

    pub unsafe fn from_raw<'a>(ptr: *const bindings::workqueue_struct) -> &'a Queue {

        // SAFETY: The `Queue` type is `#[repr(transparent)]`, so the pointer cast is valid. The

        // caller promises that the pointer is not dangling.
@@ -414,8 +414,8 @@ pub unsafe fn raw_get(ptr: *const Self) -> *mut bindings::work_struct { 
///

/// # Safety

///

/// 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.

/// 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
@@ -428,7 +428,8 @@ pub unsafe trait HasWork<T, const ID: u64 = 0> { 


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

    ///

    /// This method exists because the [`OFFSET`] constant cannot be accessed if the type is not Sized.

    /// This method exists because the [`OFFSET`] constant cannot be accessed if the type is not

    /// `Sized`.

    ///

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

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