Re: [PATCH V2] rust: Use consistent "# Examples" heading style in rustdoc
From: Viresh Kumar
Date: Wed Jun 11 2025 - 21:42:29 EST
On 10-06-25, 14:33, Viresh Kumar 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@xxxxxxxxxx>
> Signed-off-by: Viresh Kumar <viresh.kumar@xxxxxxxxxx>
> Acked-by: Benno Lossin <lossin@xxxxxxxxxx>
> ---
> V1->V2:
> - Don't change the header level for the example in workqueue.rs.
> - Update the commit log accordingly.
> - Add Ack from Benno.
>
> 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(-)
Miguel,
If you are okay, I can also take this via the PM tree along with my other rust
fixes for next rc.
--
viresh