lkml.org 
[lkml]   [2019]   [Dec]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH v2] devfreq: fix multiple kernel-doc warnings
Date
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in devfreq files.
Also fix a typo.

../include/linux/devfreq.h:181: warning: Function parameter or member 'last_status' not described in 'devfreq'

../drivers/devfreq/devfreq.c:1687: warning: bad line: - Resource-managed devfreq_register_notifier()
../drivers/devfreq/devfreq.c:1723: warning: bad line: - Resource-managed devfreq_unregister_notifier()
../drivers/devfreq/devfreq-event.c:355: warning: Function parameter or member 'edev' not described in 'devfreq_event_remove_edev'
../drivers/devfreq/devfreq-event.c:355: warning: Excess function parameter 'dev' description in 'devfreq_event_remove_edev'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Chanwoo Choi <cw00.choi@samsung.com>
Cc: linux-pm@vger.kernel.org
---
v2: update for latest devfreq tree

drivers/devfreq/devfreq-event.c | 4 ++--
drivers/devfreq/devfreq.c | 4 ++--
include/linux/devfreq.h | 3 ++-
3 files changed, 6 insertions(+), 5 deletions(-)

--- linux-next-20191213.orig/drivers/devfreq/devfreq.c
+++ linux-next-20191213/drivers/devfreq/devfreq.c
@@ -1852,7 +1852,7 @@ static void devm_devfreq_notifier_releas

/**
* devm_devfreq_register_notifier()
- - Resource-managed devfreq_register_notifier()
+ * - Resource-managed devfreq_register_notifier()
* @dev: The devfreq user device. (parent of devfreq)
* @devfreq: The devfreq object.
* @nb: The notifier block to be unregistered.
@@ -1888,7 +1888,7 @@ EXPORT_SYMBOL(devm_devfreq_register_noti

/**
* devm_devfreq_unregister_notifier()
- - Resource-managed devfreq_unregister_notifier()
+ * - Resource-managed devfreq_unregister_notifier()
* @dev: The devfreq user device. (parent of devfreq)
* @devfreq: The devfreq object.
* @nb: The notifier block to be unregistered.
--- linux-next-20191213.orig/drivers/devfreq/devfreq-event.c
+++ linux-next-20191213/drivers/devfreq/devfreq-event.c
@@ -346,9 +346,9 @@ EXPORT_SYMBOL_GPL(devfreq_event_add_edev

/**
* devfreq_event_remove_edev() - Remove the devfreq-event device registered.
- * @dev : the devfreq-event device
+ * @edev : the devfreq-event device
*
- * Note that this function remove the registered devfreq-event device.
+ * Note that this function removes the registered devfreq-event device.
*/
int devfreq_event_remove_edev(struct devfreq_event_dev *edev)
{
--- linux-next-20191213.orig/include/linux/devfreq.h
+++ linux-next-20191213/include/linux/devfreq.h
@@ -136,6 +136,7 @@ struct devfreq_stats {
* devfreq.nb to the corresponding register notifier call chain.
* @work: delayed work for load monitoring.
* @previous_freq: previously configured frequency value.
+ * @last_status: devfreq user device info, performance statistics
* @data: Private data of the governor. The devfreq framework does not
* touch this.
* @user_min_freq_req: PM QoS minimum frequency request from user (via sysfs)
@@ -151,7 +152,7 @@ struct devfreq_stats {
* @nb_min: Notifier block for DEV_PM_QOS_MIN_FREQUENCY
* @nb_max: Notifier block for DEV_PM_QOS_MAX_FREQUENCY
*
- * This structure stores the devfreq information for a give device.
+ * This structure stores the devfreq information for a given device.
*
* Note that when a governor accesses entries in struct devfreq in its
* functions except for the context of callbacks defined in struct
\
 
 \ /
  Last update: 2019-12-14 17:03    [W:0.021 / U:3.492 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site