Commit 15bc5c00 authored by Viresh Kumar's avatar Viresh Kumar Committed by Rafael J. Wysocki
Browse files

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: default avatarMiguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Signed-off-by: default avatarViresh Kumar <viresh.kumar@linaro.org>
Link: https://patch.msgid.link/9d93c783cc4419f16dd8942a4359d74bc0149203.1748323971.git.viresh.kumar@linaro.org


Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 21d8a685

rust/kernel/opp.rs

+1 −1
Original line number Diff line number Diff line
@@ -575,6 +575,7 @@ extern "C" fn config_regulators( 
/// frequency.

///

/// ```

/// # #![cfg(CONFIG_OF)]

/// use kernel::clk::Hertz;

/// use kernel::cpumask::Cpumask;

/// use kernel::device::Device;
@@ -582,7 +583,6 @@ extern "C" fn config_regulators( 
/// 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)?;

///