[PATCH v3 0/4] Replace unwraps in doctests with graceful handling

Daniel Sedlak
2024-11-23T09:50:38Z

In the following patches, I touch on error handling in the documentation
tests/examples. There are multiple occurrences of unwraps which can be
replaced by a question mark operator which should simplify the code.
Also, people typically tend to copy & paste code from the examples
(citation needed). If we leave the unwraps there, I think we can convey
the wrong impression, that it is OK to use unwraps unless the programmer
has a really good reason to use them.

Changes since v2:
- Fix typos in commit messages
- Remove unused import

Changes since RFC/v1:
- Remove opinionated changes from `rust/kernel/rbtree.rs`.
- Run clippy
- Add description to each commit message body with rationale.
- Link to RFC/v1: https://lore.kernel.org/rust-for-linux/20241116195221.373332-1-daniel@sedlak.dev/

Daniel Sedlak (4):
rust: kernel: init: replace unwraps with the question mark operators
rust: kernel: rbtree: remove unwrap in asserts
rust: kernel: page: remove unnecessary helper function from doctest
rust: kernel: str: replace unwraps with the question mark operators

rust/kernel/init.rs | 6 ++++--
rust/kernel/page.rs | 6 ++----
rust/kernel/rbtree.rs | 46 +++++++++++++++++++++----------------------
rust/kernel/str.rs | 28 +++++++++++++++-----------
4 files changed, 46 insertions(+), 40 deletions(-)

--
2.47.0