Skip to content

Commit

Permalink
cpuidle: Add a kerneldoc comment to cpuidle_use_deepest_state()
Browse files Browse the repository at this point in the history
Since cpuidle_use_deepest_state() is not static, add a proper
kerneldoc comment to it to document its purpose.

Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  • Loading branch information
Rafael J. Wysocki committed Dec 6, 2016
1 parent 8f6040c commit 0e7414b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion drivers/cpuidle/cpuidle.c
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,13 @@ static int find_deepest_state(struct cpuidle_driver *drv,
return ret;
}

/* Set the current cpu to use the deepest idle state, override governors */
/**
* cpuidle_use_deepest_state - Set/clear governor override flag.
* @enable: New value of the flag.
*
* Set/unset the current CPU to use the deepest idle state (override governors
* going forward if set).
*/
void cpuidle_use_deepest_state(bool enable)
{
struct cpuidle_device *dev;
Expand Down

0 comments on commit 0e7414b

Please sign in to comment.