]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rust: Use consistent "# Examples" heading style in rustdoc
authorViresh Kumar <viresh.kumar@linaro.org>
Tue, 10 Jun 2025 09:03:00 +0000 (14:33 +0530)
committerMiguel Ojeda <ojeda@kernel.org>
Mon, 23 Jun 2025 23:02:30 +0000 (01:02 +0200)
commitb6985083be1deb1f5fa14d160265f57d9ccb42a1
tree6cd7ea010f296acc71c90651c5313c18e8410002
parentbfb9e46b5bff33ebaac49cceb27256caceddeee5
rust: Use consistent "# Examples" heading style in rustdoc

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@kernel.org>
Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
Acked-by: Benno Lossin <lossin@kernel.org>
Link: https://lore.kernel.org/r/ddd5ce0ac20c99a72a4f1e4322d3de3911056922.1749545815.git.viresh.kumar@linaro.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
13 files changed:
rust/kernel/block/mq.rs
rust/kernel/clk.rs
rust/kernel/configfs.rs
rust/kernel/cpufreq.rs
rust/kernel/cpumask.rs
rust/kernel/devres.rs
rust/kernel/firmware.rs
rust/kernel/opp.rs
rust/kernel/pci.rs
rust/kernel/platform.rs
rust/kernel/sync.rs
rust/kernel/workqueue.rs
rust/pin-init/src/lib.rs