]> git.ipfire.org Git - thirdparty/linux.git/commit
samples: rust_misc_device: fix markup in top-level docs
authorAlice Ryhl <aliceryhl@google.com>
Thu, 13 Mar 2025 08:52:44 +0000 (08:52 +0000)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 17 Mar 2025 07:06:07 +0000 (08:06 +0100)
commita24b18aa4fd619cc7961dae3395473c355bb5b6a
treebd921a27a3fbfb6112d1c9d7e4fdf56e0e57e9a4
parent64612eb92d0e6f86ead2d141bb2107c41d7a062e
samples: rust_misc_device: fix markup in top-level docs

The meaning of /// is to document the thing that comes after it, so
currently the example is documentation for the `use core::pin::Pin;`
statement. To write top-level docs (and have them rendered as such in
the html by rustdoc), use //! instead.

This does not change the contents of the docs at all. The only change is
changing /// to //!.

Signed-off-by: Alice Ryhl <aliceryhl@google.com>
Fixes: 8d9b095b8f89 ("samples: rust_misc_device: Provide an example C program to exercise functionality")
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Reviewed-by: Christian Schrefl <chrisi.schrefl@gmail.com>
Link: https://lore.kernel.org/r/20250313-rust_misc_device_tld-v1-1-a519bced9a6d@google.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
samples/rust/rust_misc_device.rs