* [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header
@ 2012-10-29 13:02 Nishanth Menon
2012-10-29 15:32 ` Randy Dunlap
0 siblings, 1 reply; 4+ messages in thread
From: Nishanth Menon @ 2012-10-29 13:02 UTC (permalink / raw)
To: linux-pm
Cc: Nishanth Menon, Rajagopal Venkat, MyungJoo Ham, Kyungmin Park,
Rafael J. Wysocki, Kevin Hilman, linux-kernel
struct parameters need to have ':' in documentation for
scripts/kernel-doc to parse appropriately.
Fix the errors reported by:
./scripts/kernel-doc include/linux/devfreq.h >/dev/null
Cc: Rajagopal Venkat <rajagopal.venkat@linaro.org>
Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: "Rafael J. Wysocki" <rjw@sisk.pl>
Cc: Kevin Hilman <khilman@ti.com>
Cc: linux-pm@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Nishanth Menon <nm@ti.com>
---
Applies on
linux-next e083feb Merge branch 'acpi-next' into linux-next
git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git
include/linux/devfreq.h | 54 +++++++++++++++++++++++------------------------
1 file changed, 27 insertions(+), 27 deletions(-)
diff --git a/include/linux/devfreq.h b/include/linux/devfreq.h
index 7e2e2ea..1461fb2 100644
--- a/include/linux/devfreq.h
+++ b/include/linux/devfreq.h
@@ -25,12 +25,12 @@ struct devfreq;
* struct devfreq_dev_status - Data given from devfreq user device to
* governors. Represents the performance
* statistics.
- * @total_time The total time represented by this instance of
+ * @total_time: The total time represented by this instance of
* devfreq_dev_status
- * @busy_time The time that the device was working among the
+ * @busy_time: The time that the device was working among the
* total_time.
- * @current_frequency The operating frequency.
- * @private_data An entry not specified by the devfreq framework.
+ * @current_frequency: The operating frequency.
+ * @private_data: An entry not specified by the devfreq framework.
* A device and a specific governor may have their
* own protocol with private_data. However, because
* this is governor-specific, a governor using this
@@ -54,21 +54,21 @@ struct devfreq_dev_status {
/**
* struct devfreq_dev_profile - Devfreq's user device profile
- * @initial_freq The operating frequency when devfreq_add_device() is
+ * @initial_freq: The operating frequency when devfreq_add_device() is
* called.
- * @polling_ms The polling interval in ms. 0 disables polling.
- * @target The device should set its operating frequency at
+ * @polling_ms: The polling interval in ms. 0 disables polling.
+ * @target: The device should set its operating frequency at
* freq or lowest-upper-than-freq value. If freq is
* higher than any operable frequency, set maximum.
* Before returning, target function should set
* freq at the current frequency.
* The "flags" parameter's possible values are
* explained above with "DEVFREQ_FLAG_*" macros.
- * @get_dev_status The device should provide the current performance
+ * @get_dev_status: The device should provide the current performance
* status to devfreq, which is used by governors.
- * @get_cur_freq The device should provide the current frequency
+ * @get_cur_freq: The device should provide the current frequency
* at which it is operating.
- * @exit An optional callback that is called when devfreq
+ * @exit: An optional callback that is called when devfreq
* is removing the devfreq object due to error or
* from devfreq_remove_device() call. If the user
* has registered devfreq->nb at a notifier-head,
@@ -87,14 +87,14 @@ struct devfreq_dev_profile {
/**
* struct devfreq_governor - Devfreq policy governor
- * @name Governor's name
- * @get_target_freq Returns desired operating frequency for the device.
+ * @name: Governor's name
+ * @get_target_freq: Returns desired operating frequency for the device.
* Basically, get_target_freq will run
* devfreq_dev_profile.get_dev_status() to get the
* status of the device (load = busy_time / total_time).
* If no_central_polling is set, this callback is called
* only with update_devfreq() notified by OPP.
- * @event_handler Callback for devfreq core framework to notify events
+ * @event_handler: Callback for devfreq core framework to notify events
* to governors. Events include per device governor
* init and exit, opp changes out of devfreq, suspend
* and resume of per device devfreq during device idle.
@@ -110,23 +110,23 @@ struct devfreq_governor {
/**
* struct devfreq - Device devfreq structure
- * @node list node - contains the devices with devfreq that have been
+ * @node: list node - contains the devices with devfreq that have been
* registered.
- * @lock a mutex to protect accessing devfreq.
- * @dev device registered by devfreq class. dev.parent is the device
+ * @lock: a mutex to protect accessing devfreq.
+ * @dev: device registered by devfreq class. dev.parent is the device
* using devfreq.
- * @profile device-specific devfreq profile
- * @governor method how to choose frequency based on the usage.
- * @nb notifier block used to notify devfreq object that it should
+ * @profile: device-specific devfreq profile
+ * @governor: method how to choose frequency based on the usage.
+ * @nb: notifier block used to notify devfreq object that it should
* reevaluate operable frequencies. Devfreq users may use
* devfreq.nb to the corresponding register notifier call chain.
- * @work delayed work for load monitoring.
- * @previous_freq previously configured frequency value.
- * @data Private data of the governor. The devfreq framework does not
+ * @work: delayed work for load monitoring.
+ * @previous_freq: previously configured frequency value.
+ * @data: Private data of the governor. The devfreq framework does not
* touch this.
- * @min_freq Limit minimum frequency requested by user (0: none)
- * @max_freq Limit maximum frequency requested by user (0: none)
- * @stop_polling devfreq polling status of a device.
+ * @min_freq: Limit minimum frequency requested by user (0: none)
+ * @max_freq: Limit maximum frequency requested by user (0: none)
+ * @stop_polling: devfreq polling status of a device.
*
* This structure stores the devfreq information for a give device.
*
@@ -186,9 +186,9 @@ extern const struct devfreq_governor devfreq_simple_ondemand;
/**
* struct devfreq_simple_ondemand_data - void *data fed to struct devfreq
* and devfreq_add_device
- * @ upthreshold If the load is over this value, the frequency jumps.
+ * @upthreshold: If the load is over this value, the frequency jumps.
* Specify 0 to use the default. Valid value = 0 to 100.
- * @ downdifferential If the load is under upthreshold - downdifferential,
+ * @downdifferential: If the load is under upthreshold - downdifferential,
* the governor may consider slowing the frequency down.
* Specify 0 to use the default. Valid value = 0 to 100.
* downdifferential < upthreshold must hold.
--
1.7.9.5
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header
2012-10-29 13:02 [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header Nishanth Menon
@ 2012-10-29 15:32 ` Randy Dunlap
0 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2012-10-29 15:32 UTC (permalink / raw)
To: Nishanth Menon
Cc: linux-pm, Rajagopal Venkat, MyungJoo Ham, Kyungmin Park,
Rafael J. Wysocki, Kevin Hilman, linux-kernel
On 10/29/2012 06:02 AM, Nishanth Menon wrote:
> struct parameters need to have ':' in documentation for
> scripts/kernel-doc to parse appropriately.
>
> Fix the errors reported by:
> ./scripts/kernel-doc include/linux/devfreq.h >/dev/null
>
> Cc: Rajagopal Venkat <rajagopal.venkat@linaro.org>
> Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
> Cc: Kyungmin Park <kyungmin.park@samsung.com>
> Cc: "Rafael J. Wysocki" <rjw@sisk.pl>
> Cc: Kevin Hilman <khilman@ti.com>
> Cc: linux-pm@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
>
> Signed-off-by: Nishanth Menon <nm@ti.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Thanks.
> ---
> Applies on
> linux-next e083feb Merge branch 'acpi-next' into linux-next
> git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git
>
> include/linux/devfreq.h | 54 +++++++++++++++++++++++------------------------
> 1 file changed, 27 insertions(+), 27 deletions(-)
>
> diff --git a/include/linux/devfreq.h b/include/linux/devfreq.h
> index 7e2e2ea..1461fb2 100644
> --- a/include/linux/devfreq.h
> +++ b/include/linux/devfreq.h
> @@ -25,12 +25,12 @@ struct devfreq;
> * struct devfreq_dev_status - Data given from devfreq user device to
> * governors. Represents the performance
> * statistics.
> - * @total_time The total time represented by this instance of
> + * @total_time: The total time represented by this instance of
> * devfreq_dev_status
> - * @busy_time The time that the device was working among the
> + * @busy_time: The time that the device was working among the
> * total_time.
> - * @current_frequency The operating frequency.
> - * @private_data An entry not specified by the devfreq framework.
> + * @current_frequency: The operating frequency.
> + * @private_data: An entry not specified by the devfreq framework.
> * A device and a specific governor may have their
> * own protocol with private_data. However, because
> * this is governor-specific, a governor using this
> @@ -54,21 +54,21 @@ struct devfreq_dev_status {
>
> /**
> * struct devfreq_dev_profile - Devfreq's user device profile
> - * @initial_freq The operating frequency when devfreq_add_device() is
> + * @initial_freq: The operating frequency when devfreq_add_device() is
> * called.
> - * @polling_ms The polling interval in ms. 0 disables polling.
> - * @target The device should set its operating frequency at
> + * @polling_ms: The polling interval in ms. 0 disables polling.
> + * @target: The device should set its operating frequency at
> * freq or lowest-upper-than-freq value. If freq is
> * higher than any operable frequency, set maximum.
> * Before returning, target function should set
> * freq at the current frequency.
> * The "flags" parameter's possible values are
> * explained above with "DEVFREQ_FLAG_*" macros.
> - * @get_dev_status The device should provide the current performance
> + * @get_dev_status: The device should provide the current performance
> * status to devfreq, which is used by governors.
> - * @get_cur_freq The device should provide the current frequency
> + * @get_cur_freq: The device should provide the current frequency
> * at which it is operating.
> - * @exit An optional callback that is called when devfreq
> + * @exit: An optional callback that is called when devfreq
> * is removing the devfreq object due to error or
> * from devfreq_remove_device() call. If the user
> * has registered devfreq->nb at a notifier-head,
> @@ -87,14 +87,14 @@ struct devfreq_dev_profile {
>
> /**
> * struct devfreq_governor - Devfreq policy governor
> - * @name Governor's name
> - * @get_target_freq Returns desired operating frequency for the device.
> + * @name: Governor's name
> + * @get_target_freq: Returns desired operating frequency for the device.
> * Basically, get_target_freq will run
> * devfreq_dev_profile.get_dev_status() to get the
> * status of the device (load = busy_time / total_time).
> * If no_central_polling is set, this callback is called
> * only with update_devfreq() notified by OPP.
> - * @event_handler Callback for devfreq core framework to notify events
> + * @event_handler: Callback for devfreq core framework to notify events
> * to governors. Events include per device governor
> * init and exit, opp changes out of devfreq, suspend
> * and resume of per device devfreq during device idle.
> @@ -110,23 +110,23 @@ struct devfreq_governor {
>
> /**
> * struct devfreq - Device devfreq structure
> - * @node list node - contains the devices with devfreq that have been
> + * @node: list node - contains the devices with devfreq that have been
> * registered.
> - * @lock a mutex to protect accessing devfreq.
> - * @dev device registered by devfreq class. dev.parent is the device
> + * @lock: a mutex to protect accessing devfreq.
> + * @dev: device registered by devfreq class. dev.parent is the device
> * using devfreq.
> - * @profile device-specific devfreq profile
> - * @governor method how to choose frequency based on the usage.
> - * @nb notifier block used to notify devfreq object that it should
> + * @profile: device-specific devfreq profile
> + * @governor: method how to choose frequency based on the usage.
> + * @nb: notifier block used to notify devfreq object that it should
> * reevaluate operable frequencies. Devfreq users may use
> * devfreq.nb to the corresponding register notifier call chain.
> - * @work delayed work for load monitoring.
> - * @previous_freq previously configured frequency value.
> - * @data Private data of the governor. The devfreq framework does not
> + * @work: delayed work for load monitoring.
> + * @previous_freq: previously configured frequency value.
> + * @data: Private data of the governor. The devfreq framework does not
> * touch this.
> - * @min_freq Limit minimum frequency requested by user (0: none)
> - * @max_freq Limit maximum frequency requested by user (0: none)
> - * @stop_polling devfreq polling status of a device.
> + * @min_freq: Limit minimum frequency requested by user (0: none)
> + * @max_freq: Limit maximum frequency requested by user (0: none)
> + * @stop_polling: devfreq polling status of a device.
> *
> * This structure stores the devfreq information for a give device.
> *
> @@ -186,9 +186,9 @@ extern const struct devfreq_governor devfreq_simple_ondemand;
> /**
> * struct devfreq_simple_ondemand_data - void *data fed to struct devfreq
> * and devfreq_add_device
> - * @ upthreshold If the load is over this value, the frequency jumps.
> + * @upthreshold: If the load is over this value, the frequency jumps.
> * Specify 0 to use the default. Valid value = 0 to 100.
> - * @ downdifferential If the load is under upthreshold - downdifferential,
> + * @downdifferential: If the load is under upthreshold - downdifferential,
> * the governor may consider slowing the frequency down.
> * Specify 0 to use the default. Valid value = 0 to 100.
> * downdifferential < upthreshold must hold.
--
~Randy
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header
2012-10-31 2:27 함명주
@ 2012-10-31 9:13 ` Rafael J. Wysocki
0 siblings, 0 replies; 4+ messages in thread
From: Rafael J. Wysocki @ 2012-10-31 9:13 UTC (permalink / raw)
To: myungjoo.ham
Cc: Randy Dunlap, Nishanth Menon, linux-pm, Rajagopal Venkat,
박경민,
Kevin Hilman, linux-kernel, 이종화
On Wednesday, October 31, 2012 02:27:10 AM 함명주 wrote:
> > On Tuesday, October 30, 2012 08:09:09 AM MyungJoo Ham wrote:
> []
> > >
> > > Acked-by: MyungJoo Ham <myungjoo.ham@samsung.com>
> > >
> > > Applying to git://git.kernel.org/pub/scm/linux/kernel/git/mzx/devfreq.git for-rafael, which is based on rafael's linux-pm.git / linux-next.
> > >
> > > http://git.kernel.org/?p=linux/kernel/git/mzx/devfreq.git;a=shortlog;h=refs/heads/for-rafael
> > >
> > > I'll apply your "Add sysfs node ..." patch after refactoring with Jonghwa's (devfreq trans_stat) as the two patches use the same data (list of available freqs).
> >
> > May I assume that you'll handle all of the subsequent devfreq patches too?
> >
> > Rafael
>
> Yes, you may. I'll apply the patches (currently at http://git.kernel.org/?p=linux/kernel/git/mzx/devfreq.git;a=shortlog;h=refs/heads/for-rafael ) and send pull requests to you or Linus.
>
> Anyway, do you want me to keep sending pull requests to you as you've told
> last time?
Yes, please.
Thanks,
Rafael
--
I speak only for myself.
Rafael J. Wysocki, Intel Open Source Technology Center.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header
2012-10-30 8:09 MyungJoo Ham
@ 2012-10-30 23:43 ` Rafael J. Wysocki
0 siblings, 0 replies; 4+ messages in thread
From: Rafael J. Wysocki @ 2012-10-30 23:43 UTC (permalink / raw)
To: myungjoo.ham
Cc: Randy Dunlap, Nishanth Menon, linux-pm, Rajagopal Venkat,
박경민,
Kevin Hilman, linux-kernel, 이종화
On Tuesday, October 30, 2012 08:09:09 AM MyungJoo Ham wrote:
> > On 10/29/2012 06:02 AM, Nishanth Menon wrote:
> >
> > > struct parameters need to have ':' in documentation for
> > > scripts/kernel-doc to parse appropriately.
> > >
> > > Fix the errors reported by:
> > > ./scripts/kernel-doc include/linux/devfreq.h >/dev/null
> > >
> > > Cc: Rajagopal Venkat <rajagopal.venkat@linaro.org>
> > > Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
> > > Cc: Kyungmin Park <kyungmin.park@samsung.com>
> > > Cc: "Rafael J. Wysocki" <rjw@sisk.pl>
> > > Cc: Kevin Hilman <khilman@ti.com>
> > > Cc: linux-pm@vger.kernel.org
> > > Cc: linux-kernel@vger.kernel.org
> > >
> > > Signed-off-by: Nishanth Menon <nm@ti.com>
> >
> >
> > Acked-by: Randy Dunlap <rdunlap@xenotime.net>
> >
> > Thanks.
>
> Acked-by: MyungJoo Ham <myungjoo.ham@samsung.com>
>
> Applying to git://git.kernel.org/pub/scm/linux/kernel/git/mzx/devfreq.git for-rafael, which is based on rafael's linux-pm.git / linux-next.
>
> http://git.kernel.org/?p=linux/kernel/git/mzx/devfreq.git;a=shortlog;h=refs/heads/for-rafael
>
> I'll apply your "Add sysfs node ..." patch after refactoring with Jonghwa's (devfreq trans_stat) as the two patches use the same data (list of available freqs).
May I assume that you'll handle all of the subsequent devfreq patches too?
Rafael
--
I speak only for myself.
Rafael J. Wysocki, Intel Open Source Technology Center.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2012-10-31 9:09 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-10-29 13:02 [linux-next PATCH] PM / devfreq: documentation cleanups for devfreq header Nishanth Menon
2012-10-29 15:32 ` Randy Dunlap
2012-10-30 8:09 MyungJoo Ham
2012-10-30 23:43 ` Rafael J. Wysocki
2012-10-31 2:27 함명주
2012-10-31 9:13 ` Rafael J. Wysocki
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).