From 0e7414b7aa8b294fddefbad020798f7c8ebe1622 Mon Sep 17 00:00:00 2001 From: "Rafael J. Wysocki" Date: Thu, 1 Dec 2016 23:31:32 +0100 Subject: [PATCH] cpuidle: Add a kerneldoc comment to cpuidle_use_deepest_state() 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 --- drivers/cpuidle/cpuidle.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/drivers/cpuidle/cpuidle.c b/drivers/cpuidle/cpuidle.c index afc005b917fe..62810ff3b00f 100644 --- a/drivers/cpuidle/cpuidle.c +++ b/drivers/cpuidle/cpuidle.c @@ -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;