Commit 8333ff4d authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

rust: rbtree: fix `SAFETY` comments that should be `# Safety` sections 



The tag `SAFETY` is used for safety comments, i.e. `// SAFETY`, while a
`Safety` section is used for safety preconditions in code documentation,
i.e. `/// # Safety`.

Fix the three instances recently added in `rbtree` that Clippy would
have normally caught in a public item, so that we can enable checking
of private items in one of the following commits.

Fixes: 98c14e40 ("rust: rbtree: add cursor")
Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Tested-by: default avatarGary Guo <gary@garyguo.net>
Reviewed-by: default avatarGary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/r/20240904204347.168520-14-ojeda@kernel.org


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

rust/kernel/rbtree.rs

+6 −3
Original line number Diff line number Diff line
@@ -884,7 +884,8 @@ fn get_neighbor_raw(&self, direction: Direction) -> Option<NonNull<bindings::rb_ 
        NonNull::new(neighbor)

    }



    /// SAFETY:

    /// # Safety

    ///

    /// - `node` must be a valid pointer to a node in an [`RBTree`].

    /// - The caller has immutable access to `node` for the duration of 'b.

    unsafe fn to_key_value<'b>(node: NonNull<bindings::rb_node>) -> (&'b K, &'b V) {
@@ -894,7 +895,8 @@ unsafe fn to_key_value<'b>(node: NonNull<bindings::rb_node>) -> (&'b K, &'b V) { 
        (k, unsafe { &*v })

    }



    /// SAFETY:

    /// # Safety

    ///

    /// - `node` must be a valid pointer to a node in an [`RBTree`].

    /// - The caller has mutable access to `node` for the duration of 'b.

    unsafe fn to_key_value_mut<'b>(node: NonNull<bindings::rb_node>) -> (&'b K, &'b mut V) {
@@ -904,7 +906,8 @@ unsafe fn to_key_value_mut<'b>(node: NonNull<bindings::rb_node>) -> (&'b K, &'b 
        (k, unsafe { &mut *v })

    }



    /// SAFETY:

    /// # Safety

    ///

    /// - `node` must be a valid pointer to a node in an [`RBTree`].

    /// - The caller has immutable access to the key for the duration of 'b.

    unsafe fn to_key_value_raw<'b>(node: NonNull<bindings::rb_node>) -> (&'b K, *mut V) {