Message ID | 50975461-6dab-8f89-e802-b34ca06008f5@infradead.org (mailing list archive) |
---|---|
State | Changes Requested, archived |
Headers | show |
Series | devfreq: fix multiple kernel-doc warnings | expand |
Hi, Thanks. But, You need to rebase it on updated devfreq-next or linux-next after today. Because, when I applied it to updated devfreq-next after released v5.5-rc1, the merge conflict happen. Please rebase and resend it. Regards, Chanwoo Choi On 12/9/19 1:34 PM, Randy Dunlap wrote: > 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 > --- > 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-20191209.orig/drivers/devfreq/devfreq.c > +++ linux-next-20191209/drivers/devfreq/devfreq.c > @@ -1733,7 +1733,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. > @@ -1769,7 +1769,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-20191209.orig/drivers/devfreq/devfreq-event.c > +++ linux-next-20191209/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-20191209.orig/include/linux/devfreq.h > +++ linux-next-20191209/include/linux/devfreq.h > @@ -135,6 +135,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. > * @min_freq: Limit minimum frequency requested by user (0: none) > @@ -148,7 +149,7 @@ struct devfreq_stats { > * @stats: Statistics of devfreq device behavior > * @transition_notifier_list: list head of DEVFREQ_TRANSITION_NOTIFIER notifier > * > - * 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 > > >
--- linux-next-20191209.orig/drivers/devfreq/devfreq.c +++ linux-next-20191209/drivers/devfreq/devfreq.c @@ -1733,7 +1733,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. @@ -1769,7 +1769,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-20191209.orig/drivers/devfreq/devfreq-event.c +++ linux-next-20191209/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-20191209.orig/include/linux/devfreq.h +++ linux-next-20191209/include/linux/devfreq.h @@ -135,6 +135,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. * @min_freq: Limit minimum frequency requested by user (0: none) @@ -148,7 +149,7 @@ struct devfreq_stats { * @stats: Statistics of devfreq device behavior * @transition_notifier_list: list head of DEVFREQ_TRANSITION_NOTIFIER notifier * - * 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