linux-kernel - Re: [PATCH] samples: rust_misc_device: fix markup in top-level docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <D8F31D220PWN.AJV57JVJZYXY@proton.me>
Date: Thu, 13 Mar 2025 10:56:30 +0000
From: Benno Lossin <benno.lossin@...ton.me>
To: Alice Ryhl <aliceryhl@...gle.com>, Greg Kroah-Hartman <gregkh@...uxfoundation.org>, Arnd Bergmann <arnd@...db.de>, Miguel Ojeda <ojeda@...nel.org>
Cc: Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, Björn Roy Baron <bjorn3_gh@...tonmail.com>, Andreas Hindborg <a.hindborg@...nel.org>, Trevor Gross <tmgross@...ch.edu>, Lee Jones <lee@...nel.org>, rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] samples: rust_misc_device: fix markup in top-level docs

On Thu Mar 13, 2025 at 9:52 AM CET, Alice Ryhl wrote:
> 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@...gle.com>

Good catch! I think this should have a fixes tag:

    Fixes: 8d9b095b8f89 ("samples: rust_misc_device: Provide an example C program to exercise functionality")

Reviewed-by: Benno Lossin <benno.lossin@...ton.me>

---
Cheers,
Benno

> ---
>  samples/rust/rust_misc_device.rs | 181 ++++++++++++++++++++-------------------
>  1 file changed, 91 insertions(+), 90 deletions(-)