[PATCH v3 0/3] rust: add kunit doctest with doc fixes

Jimmy Ostler
2024-12-18T00:23:54Z

This patch series adds a doctest for the `ArrayLayout` type, as well as
implements `From<LayoutError> for Error` for the internal `LayoutError`.
This change in the first patch is required for the added rustdoc kunit
test in the third patch to compile.

This series also adds a change to the `stack_try_pin_init` example
documentation, so it correctly imports the `AllocError` kernel type.

Link: https://lore.kernel.org/lkml/20241203051843.291729-1-jtostler1@gmail.com/ [v1]
Link: https://lore.kernel.org/lkml/20241205105627.992587-1-jtostler1@gmail.com/ [v2]
Signed-off-by: Jimmy Ostler <jtostler1@gmail.com>
---
v2 -> v3:
- Remove `From` implementation on `core::alloc::LayoutError`
- Move changes to "rust/kernel/alloc/layout.rs" to separate patch
- Move changes to "rust/kernel/error.rs" to separate patch
- Change documentation in "rust/kernel/init.rs"
- Link [v2]: https://lore.kernel.org/lkml/20241205105627.992587-1-jtostler1@gmail.com/

v1 -> v2 changes:
- Add third assert where length is smaller but still overflows
- Remove rustdoc markdown codeblock languge signifier
- Change tests to return results using `?` instead of panic
- Remove `#[derive(Debug)]` for `LayoutError`
- Add `From<LayoutError> for Error` implementation
- Link [v1]: https://lore.kernel.org/lkml/20241203051843.291729-1-jtostler1@gmail.com/

Jimmy Ostler (3):
rust: error: Change `LayoutError` to internal
rust: error: Update 'stack_try_pin_init' example
rust: alloc: Add doctest for `ArrayLayout`

rust/kernel/alloc/layout.rs | 19 +++++++++++++++++++
rust/kernel/error.rs | 7 ++++---
rust/kernel/init.rs | 22 ++++++++++++++++++----
3 files changed, 41 insertions(+), 7 deletions(-)

base-commit: 9a02cbc5139e668f8b74e75a611d3a04b5241228
--
2.47.1