Dirk Behme 718c406989 rust: types: extend Opaque documentation ... Update the `Opaque` documentation and add an example as proposed by Miguel Ojeda in [1]. The documentation update is mainly taken from Benno Lossin's description [2]. Cc: Nell Shamrell-Harrington <nells@linux.microsoft.com> Suggested-by: Miguel Ojeda <ojeda@kernel.org> Link: https://rust-for-linux.zulipchat.com/#narrow/stream/291565/topic/x/near/467478085 [1] Link: https://rust-for-linux.zulipchat.com/#narrow/stream/291565/topic/x/near/470498289 [2] Co-developed-by: Benno Lossin <benno.lossin@proton.me> Signed-off-by: Benno Lossin <benno.lossin@proton.me> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com> Link: https://lore.kernel.org/r/20241002050301.1927545-1-dirk.behme@de.bosch.com [ Used `expect`. Rewrapped docs. Added intra-doc link. Formatted example. Reworded to fix tag typo/order. Fixed `&mut` formatting as discussed. Added Benno's SOB and CDB as discussed. Shortened links. - Miguel ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>		2024-10-24 18:29:27 +02:00
..
alloc	kbuild: rust: remove the alloc crate and GlobalAlloc	2024-10-15 23:10:32 +02:00
block	rust: block: fix formatting of kernel::block::mq::request module	2024-10-22 20:04:01 +02:00
init	rust: treewide: switch to our kernel Box type	2024-10-15 22:56:59 +02:00
list	rust: enable arbitrary_self_types and remove Receiver	2024-10-07 21:39:57 +02:00
net	Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net	2024-09-05 20:37:20 -07:00
sync	rust: treewide: switch to the kernel Vec type	2024-10-15 23:10:32 +02:00
alloc.rs	rust: alloc: update module comment of alloc.rs	2024-10-15 23:10:32 +02:00
block.rs	rust: block: introduce kernel::block::mq module	2024-06-14 07:45:04 -06:00
build_assert.rs	rust: upgrade to Rust 1.68.2	2023-05-31 17:35:03 +02:00
device.rs	device: rust: improve safety comments	2024-06-20 16:14:58 +02:00
error.rs	rust: error: check for config test in Error::name	2024-10-15 23:10:32 +02:00
firmware.rs	rust: firmware: fix invalid rustdoc link	2024-07-31 13:24:29 +02:00
init.rs	rust: alloc: remove extension of std's Box	2024-10-15 22:56:59 +02:00
ioctl.rs	rust: start using the #[expect(...)] attribute	2024-10-07 21:39:57 +02:00
kunit.rs	rust: kunit: use C-string literals to clean warning	2024-10-01 23:46:42 +02:00
lib.rs	rust: kernel: fix THIS_MODULE header path in ThisModule doc comment	2024-10-21 20:35:53 +02:00
list.rs	rust: enable clippy::undocumented_unsafe_blocks lint	2024-10-07 21:39:05 +02:00
net.rs	rust: core abstractions for network PHY drivers	2023-12-15 09:35:50 +00:00
page.rs	rust: page: add Rust version of PAGE_ALIGN	2024-10-21 20:34:46 +02:00
prelude.rs	rust: alloc: add Vec to prelude	2024-10-15 23:10:32 +02:00
print.rs	rust: start using the #[expect(...)] attribute	2024-10-07 21:39:57 +02:00
rbtree.rs	rust: treewide: switch to our kernel Box type	2024-10-15 22:56:59 +02:00
sizes.rs	rust: sizes: add commonly used constants	2024-08-30 10:27:34 +01:00
static_assert.rs	rust: static_assert: add static_assert! macro	2022-12-04 01:59:16 +01:00
std_vendor.rs	rust: std_vendor: update dbg macro from Rust upstream	2024-10-10 00:33:42 +02:00
str.rs	rust: str: test: replace alloc::format	2024-10-15 23:10:32 +02:00
sync.rs	rust: sync: implement Default for LockClassKey	2024-05-05 19:22:25 +02:00
task.rs	rust: kernel: remove redundant imports	2024-05-05 19:22:25 +02:00
time.rs	rust: time: doc: Add missing C header links	2024-05-01 00:04:47 +02:00
transmute.rs	rust: kernel: move FromBytes and AsBytes traits to a new transmute module	2024-10-10 00:33:42 +02:00
types.rs	rust: types: extend Opaque documentation	2024-10-24 18:29:27 +02:00
uaccess.rs	rust: treewide: switch to the kernel Vec type	2024-10-15 23:10:32 +02:00
workqueue.rs	rust: treewide: switch to our kernel Box type	2024-10-15 22:56:59 +02:00