[PATCH] PM: <linux/device.h>: fix @em_pd kernel-doc warning

[PATCH] PM: <linux/device.h>: fix @em_pd kernel-doc warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning in <linux/device.h>:

../include/linux/device.h:613: warning: Function parameter or member 'em_pd' not described in 'device'

Fixes: 1bc138c62295 ("PM / EM: add support for other devices than CPUs in Energy Model")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Lukasz Luba <lukasz.luba@arm.com>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
---
 include/linux/device.h |    1 +
 1 file changed, 1 insertion(+)

--- lnx-59-rc4.orig/include/linux/device.h
+++ lnx-59-rc4/include/linux/device.h
@@ -454,6 +454,7 @@ struct dev_links_info {
  * @pm_domain:	Provide callbacks that are executed during system suspend,
  * 		hibernation, system resume and during runtime PM transitions
  * 		along with subsystem-level and driver-level callbacks.
+ * @em_pd:	device's energy model performance domain
  * @pins:	For device pin management.
  *		See Documentation/driver-api/pinctl.rst for details.
  * @msi_list:	Hosts MSI descriptors

Re: [PATCH] PM: <linux/device.h>: fix @em_pd kernel-doc warning

[Lukasz Luba]

Hi Randy,

On 9/7/20 4:42 AM, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning in <linux/device.h>:
> 
> ../include/linux/device.h:613: warning: Function parameter or member 'em_pd' not described in 'device'
> 
> Fixes: 1bc138c62295 ("PM / EM: add support for other devices than CPUs in Energy Model")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Lukasz Luba <lukasz.luba@arm.com>
> Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> ---
>   include/linux/device.h |    1 +
>   1 file changed, 1 insertion(+)
> 
> --- lnx-59-rc4.orig/include/linux/device.h
> +++ lnx-59-rc4/include/linux/device.h
> @@ -454,6 +454,7 @@ struct dev_links_info {
>    * @pm_domain:	Provide callbacks that are executed during system suspend,
>    * 		hibernation, system resume and during runtime PM transitions
>    * 		along with subsystem-level and driver-level callbacks.
> + * @em_pd:	device's energy model performance domain
>    * @pins:	For device pin management.
>    *		See Documentation/driver-api/pinctl.rst for details.
>    * @msi_list:	Hosts MSI descriptors
> 

Good catch. Thank you for the patch.

Reviewed-by: Lukasz Luba <lukasz.luba@arm.com>

Regards,
Lukasz Luba

Re: [PATCH] PM: <linux/device.h>: fix @em_pd kernel-doc warning

[Rafael J. Wysocki]

On Mon, Sep 7, 2020 at 5:43 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warning in <linux/device.h>:
>
> ../include/linux/device.h:613: warning: Function parameter or member 'em_pd' not described in 'device'
>
> Fixes: 1bc138c62295 ("PM / EM: add support for other devices than CPUs in Energy Model")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Lukasz Luba <lukasz.luba@arm.com>
> Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> ---
>  include/linux/device.h |    1 +
>  1 file changed, 1 insertion(+)
>
> --- lnx-59-rc4.orig/include/linux/device.h
> +++ lnx-59-rc4/include/linux/device.h
> @@ -454,6 +454,7 @@ struct dev_links_info {
>   * @pm_domain: Provide callbacks that are executed during system suspend,
>   *             hibernation, system resume and during runtime PM transitions
>   *             along with subsystem-level and driver-level callbacks.
> + * @em_pd:     device's energy model performance domain
>   * @pins:      For device pin management.
>   *             See Documentation/driver-api/pinctl.rst for details.
>   * @msi_list:  Hosts MSI descriptors
>

Applied as 5.9-rc material, thanks!