linux-kernel - Re: [PATCH V2] 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] [day] [month] [year] [list]

Message-ID: <CANiq72k9_bzjV7YbFL1NZTESjFYRiiLgYaGHYv_m9hNa+p9zmA@mail.gmail.com>
Date: Tue, 24 Jun 2025 01:13:46 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Viresh Kumar <viresh.kumar@...aro.org>
Cc: 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>, 
	Benno Lossin <lossin@...nel.org>, 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>, 
	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 V2] rust: Use consistent "# Examples" heading style in rustdoc

On Tue, Jun 10, 2025 at 11:03 AM Viresh Kumar <viresh.kumar@...aro.org> wrote:
>
> Use a consistent `# Examples` heading in rustdoc across the codebase.
>
> Some modules previously used `## Examples` (even when they should be
> available as top-level headers), while others used `# Example`, which
> deviates from the preferred `# Examples` style.
>
> Suggested-by: Miguel Ojeda <ojeda@...nel.org>
> Signed-off-by: Viresh Kumar <viresh.kumar@...aro.org>
> Acked-by: Benno Lossin <lossin@...nel.org>

Applied to `rust-next` -- thanks everyone!

This is a trivial change that shouldn't be able to break anything
anywhere, and I haven't heard any complaints, so I will go ahead and
take it.

If someone wants to give Acked-by's, I can still take them.

Cheers,
Miguel