linux-kernel - Re: [PATCH] rust: Use consistent "# Examples" heading style in rustdoc

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: <DAIQ4GUF8JGO.2EL4XVGRV06R0@kernel.org>
Date: Tue, 10 Jun 2025 10:51:52 +0200
From: "Benno Lossin" <lossin@...nel.org>
To: "Viresh Kumar" <viresh.kumar@...aro.org>, "Andreas Hindborg"
 <a.hindborg@...nel.org>, "Boqun Feng" <boqun.feng@...il.com>, "Michael
 Turquette" <mturquette@...libre.com>, "Stephen Boyd" <sboyd@...nel.org>,
 "Miguel Ojeda" <ojeda@...nel.org>, "Alex Gaynor" <alex.gaynor@...il.com>,
 "Gary Guo" <gary@...yguo.net>, Björn Roy Baron
 <bjorn3_gh@...tonmail.com>, "Alice Ryhl" <aliceryhl@...gle.com>, "Trevor
 Gross" <tmgross@...ch.edu>, "Danilo Krummrich" <dakr@...nel.org>, "Breno
 Leitao" <leitao@...ian.org>, "Rafael J. Wysocki" <rafael@...nel.org>, "Yury
 Norov" <yury.norov@...il.com>, "Greg Kroah-Hartman"
 <gregkh@...uxfoundation.org>, "Luis Chamberlain" <mcgrof@...nel.org>, "Russ
 Weight" <russ.weight@...ux.dev>, "Nishanth Menon" <nm@...com>, "Bjorn
 Helgaas" <bhelgaas@...gle.com>, Krzysztof Wilczyński
 <kwilczynski@...nel.org>
Cc: "Vincent Guittot" <vincent.guittot@...aro.org>,
 <linux-block@...r.kernel.org>, <rust-for-linux@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>, <linux-clk@...r.kernel.org>,
 <linux-pm@...r.kernel.org>, <linux-pci@...r.kernel.org>
Subject: Re: [PATCH] rust: Use consistent "# Examples" heading style in
 rustdoc

On Tue Jun 10, 2025 at 6:37 AM CEST, Viresh Kumar wrote:
> Use a consistent `# Examples` heading in rustdoc across the codebase.
>
> Some modules previously used `## Examples` or `# Example`, which deviates
> from the preferred `# Examples` style.
>
> Suggested-by: Miguel Ojeda <ojeda@...nel.org>
> Signed-off-by: Viresh Kumar <viresh.kumar@...aro.org>
> ---
>  rust/kernel/block/mq.rs  |  2 +-
>  rust/kernel/clk.rs       |  6 +++---
>  rust/kernel/configfs.rs  |  2 +-
>  rust/kernel/cpufreq.rs   |  8 ++++----
>  rust/kernel/cpumask.rs   |  4 ++--
>  rust/kernel/devres.rs    |  4 ++--
>  rust/kernel/firmware.rs  |  4 ++--
>  rust/kernel/opp.rs       | 16 ++++++++--------
>  rust/kernel/pci.rs       |  4 ++--
>  rust/kernel/platform.rs  |  2 +-
>  rust/kernel/sync.rs      |  2 +-
>  rust/kernel/workqueue.rs |  2 +-
>  rust/pin-init/src/lib.rs |  2 +-
>  13 files changed, 29 insertions(+), 29 deletions(-)

> diff --git a/rust/pin-init/src/lib.rs b/rust/pin-init/src/lib.rs
> index 9ab34036e6bc..c5f395b44ec8 100644
> --- a/rust/pin-init/src/lib.rs
> +++ b/rust/pin-init/src/lib.rs
> @@ -953,7 +953,7 @@ macro_rules! try_init {
>  /// Asserts that a field on a struct using `#[pin_data]` is marked with `#[pin]` ie. that it is
>  /// structurally pinned.
>  ///
> -/// # Example
> +/// # Examples
>  ///
>  /// This will succeed:
>  /// ```

@Miguel, if you take this, then:

Acked-by: Benno Lossin <lossin@...nel.org>

For such a small change I don't mind upstreaming it myself, but if
Viresh wants to have a merged GitHub PR in pin-init, then we can take it
that route.

---
Cheers,
Benno