Commit b61b0092 authored by Albin Babu Varghese's avatar Albin Babu Varghese Committed by Miguel Ojeda
Browse files

rust: list: replace unwrap() with ? in doctest examples 



Using `unwrap()` in kernel doctests can cause panics on error and may
give newcomers the mistaken impression that panicking is acceptable
in kernel code.

Replace all `.unwrap()` calls in `kernel::list`
examples with `.ok_or(EINVAL)?` so that errors are properly propagated.

Suggested-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1164


Reviewed-by: default avatarBenno Lossin <lossin@kernel.org>
Signed-off-by: default avatarAlbin Babu Varghese <albinbabuvarghese20@gmail.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Reviewed-by: default avatarDanilo Krummrich <dakr@kernel.org>
Link: https://lore.kernel.org/r/20250527204928.5117-1-albinbabuvarghese20@gmail.com


[ Reworded slightly. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 5d4ffc53

rust/kernel/list.rs

+19 −19
Original line number Diff line number Diff line
@@ -82,9 +82,9 @@ 
/// // [15, 10, 30]

/// {

///     let mut iter = list.iter();

///     assert_eq!(iter.next().unwrap().value, 15);

///     assert_eq!(iter.next().unwrap().value, 10);

///     assert_eq!(iter.next().unwrap().value, 30);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 15);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 10);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 30);

///     assert!(iter.next().is_none());

///

///     // Verify the length of the list.
@@ -93,9 +93,9 @@ 
///

/// // Pop the items from the list using `pop_back()` and verify the content.

/// {

///     assert_eq!(list.pop_back().unwrap().value, 30);

///     assert_eq!(list.pop_back().unwrap().value, 10);

///     assert_eq!(list.pop_back().unwrap().value, 15);

///     assert_eq!(list.pop_back().ok_or(EINVAL)?.value, 30);

///     assert_eq!(list.pop_back().ok_or(EINVAL)?.value, 10);

///     assert_eq!(list.pop_back().ok_or(EINVAL)?.value, 15);

/// }

///

/// // Insert 3 elements using `push_front()`.
@@ -107,9 +107,9 @@ 
/// // [30, 10, 15]

/// {

///     let mut iter = list.iter();

///     assert_eq!(iter.next().unwrap().value, 30);

///     assert_eq!(iter.next().unwrap().value, 10);

///     assert_eq!(iter.next().unwrap().value, 15);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 30);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 10);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 15);

///     assert!(iter.next().is_none());

///

///     // Verify the length of the list.
@@ -118,8 +118,8 @@ 
///

/// // Pop the items from the list using `pop_front()` and verify the content.

/// {

///     assert_eq!(list.pop_front().unwrap().value, 30);

///     assert_eq!(list.pop_front().unwrap().value, 10);

///     assert_eq!(list.pop_front().ok_or(EINVAL)?.value, 30);

///     assert_eq!(list.pop_front().ok_or(EINVAL)?.value, 10);

/// }

///

/// // Push `list2` to `list` through `push_all_back()`.
@@ -135,9 +135,9 @@ 
///     // list: [15, 25, 35]

///     // list2: []

///     let mut iter = list.iter();

///     assert_eq!(iter.next().unwrap().value, 15);

///     assert_eq!(iter.next().unwrap().value, 25);

///     assert_eq!(iter.next().unwrap().value, 35);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 15);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 25);

///     assert_eq!(iter.next().ok_or(EINVAL)?.value, 35);

///     assert!(iter.next().is_none());

///     assert!(list2.is_empty());

/// }
@@ -809,11 +809,11 @@ fn next(&mut self) -> Option<ArcBorrow<'a, T>> { 
/// merge_sorted(&mut list, list2);

///

/// let mut items = list.into_iter();

/// assert_eq!(items.next().unwrap().value, 10);

/// assert_eq!(items.next().unwrap().value, 11);

/// assert_eq!(items.next().unwrap().value, 12);

/// assert_eq!(items.next().unwrap().value, 13);

/// assert_eq!(items.next().unwrap().value, 14);

/// assert_eq!(items.next().ok_or(EINVAL)?.value, 10);

/// assert_eq!(items.next().ok_or(EINVAL)?.value, 11);

/// assert_eq!(items.next().ok_or(EINVAL)?.value, 12);

/// assert_eq!(items.next().ok_or(EINVAL)?.value, 13);

/// assert_eq!(items.next().ok_or(EINVAL)?.value, 14);

/// assert!(items.next().is_none());

/// # Result::<(), Error>::Ok(())

/// ```