[PATCH] rust: list: remove nonexistent insert_at() from the comments

[PATCH] rust: list: remove nonexistent insert_at() from the comments

[Zhi Wang]

The insert_at() method was never introduced in the code. Remove it from
the comments to avoid confusion.

No functional change intended.

Fixes: 52ae96f5187c ("rust: list: make the cursor point between elements")
Signed-off-by: Zhi Wang <zhiw@nvidia.com>
---
 rust/kernel/list.rs | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/rust/kernel/list.rs b/rust/kernel/list.rs
index 44e5219cfcbc..f40eaa17a8fc 100644
--- a/rust/kernel/list.rs
+++ b/rust/kernel/list.rs
@@ -761,19 +761,6 @@ fn next(&mut self) -> Option<ArcBorrow<'a, T>> {
 ///     out
 /// }
 ///
-/// // Use a cursor to insert a value at a specific index. Returns an error if the index is out of
-/// // bounds.
-/// fn insert_at(list: &mut List<ListItem>, new: ListArc<ListItem>, idx: usize) -> Result {
-///     let mut cursor = list.cursor_front();
-///     for _ in 0..idx {
-///         if !cursor.move_next() {
-///             return Err(EINVAL);
-///         }
-///     }
-///     cursor.insert_next(new);
-///     Ok(())
-/// }
-///
 /// // Merge two sorted lists into a single sorted list.
 /// fn merge_sorted(list: &mut List<ListItem>, merge: List<ListItem>) {
 ///     let mut cursor = list.cursor_front();
@@ -799,8 +786,6 @@ fn next(&mut self) -> Option<ArcBorrow<'a, T>> {
 /// // [14, 10, 15, 14]
 /// assert!(remove_first(&mut list, 14).is_some());
 /// // [10, 15, 14]
-/// insert_at(&mut list, ListItem::new(12)?, 2)?;
-/// // [10, 15, 12, 14]
 /// assert!(remove_last(&mut list, 15).is_some());
 /// // [10, 12, 14]
 ///
-- 
2.43.5

Re: [PATCH] rust: list: remove nonexistent insert_at() from the comments

[Miguel Ojeda]

On Sat, Aug 2, 2025 at 11:00 PM Zhi Wang <zhiw@nvidia.com> wrote:
>
> The insert_at() method was never introduced in the code. Remove it from
> the comments to avoid confusion.

Hmm... I am not sure what you mean -- `insert_at()` is an example
function, used in the example itself.

Why would we remove that one, and not the others in the example, e.g.
`remove_all`?

Cheers,
Miguel

Re: [PATCH] rust: list: remove nonexistent insert_at() from the comments

[Zhi Wang]

On Sat, 2 Aug 2025 23:31:10 +0200
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrote:

> On Sat, Aug 2, 2025 at 11:00 PM Zhi Wang <zhiw@nvidia.com> wrote:
> >
> > The insert_at() method was never introduced in the code. Remove it
> > from the comments to avoid confusion.
> 
> Hmm... I am not sure what you mean -- `insert_at()` is an example
> function, used in the example itself.
> 
> Why would we remove that one, and not the others in the example, e.g.
> `remove_all`?
> 

Oh, you are right, I lost the context when reading the code and
hacking the list routines at late night.

Please drop this.

> Cheers,
> Miguel
>