diff options
| author | Viresh Kumar <viresh.kumar@linaro.org> | 2025-05-27 11:03:26 +0530 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2025-05-27 15:29:17 +0200 |
| commit | 15bc5c00d10fb643df7939d34438d50ffa732cb2 (patch) | |
| tree | e4d86324bfd4839589e2e9bfa51b66dc9fa878e7 /rust/kernel | |
| parent | 21d8a6857bc11f3fa14b19768d840cf6d1f3fccd (diff) | |
rust: opp: Move `cfg(CONFIG_OF)` attribute to the top of doc test
Move the `#[cfg(CONFIG_OF)]` attribute to the top of the documentation test
block and hide it. This applies the condition to the entire test and improves
readability.
Placing configuration flags like `CONFIG_OF` at the top serves as a clear
indicator of the conditions under which the example is valid, effectively
acting like configuration metadata for the example itself.
Suggested-by: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
Link: https://patch.msgid.link/9d93c783cc4419f16dd8942a4359d74bc0149203.1748323971.git.viresh.kumar@linaro.org
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'rust/kernel')
| -rw-r--r-- | rust/kernel/opp.rs | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/rust/kernel/opp.rs b/rust/kernel/opp.rs index c2bdc11f3999..a566fc3e7dcb 100644 --- a/rust/kernel/opp.rs +++ b/rust/kernel/opp.rs @@ -575,6 +575,7 @@ impl<T: ConfigOps + Default> Config<T> { /// frequency. /// /// ``` +/// # #![cfg(CONFIG_OF)] /// use kernel::clk::Hertz; /// use kernel::cpumask::Cpumask; /// use kernel::device::Device; @@ -582,7 +583,6 @@ impl<T: ConfigOps + Default> Config<T> { /// use kernel::opp::Table; /// use kernel::types::ARef; /// -/// #[cfg(CONFIG_OF)] /// fn get_table(dev: &ARef<Device>, mask: &mut Cpumask, freq: Hertz) -> Result<Table> { /// let mut opp_table = Table::from_of_cpumask(dev, mask)?; /// |