[PATCH] PM / core: fix kerneldoc comment for device_pm_wait_for_dev

[PATCH] PM / core: fix kerneldoc comment for device_pm_wait_for_dev

[Yangtao Li]

Rearrange comment to make the comment style consistent, the previous
function parameters are described first.

Signed-off-by: Yangtao Li <tiny.windzz@gmail.com>
---
 drivers/base/power/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/base/power/main.c b/drivers/base/power/main.c
index 0cff68bd7b4b..eddb54057ed6 100644
--- a/drivers/base/power/main.c
+++ b/drivers/base/power/main.c
@@ -2069,8 +2069,8 @@ EXPORT_SYMBOL_GPL(__suspend_report_result);
 
 /**
  * device_pm_wait_for_dev - Wait for suspend/resume of a device to complete.
- * @dev: Device to wait for.
  * @subordinate: Device that needs to wait for @dev.
+ * @dev: Device to wait for.
  */
 int device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
 {
-- 
2.17.0

Re: [PATCH] PM / core: fix kerneldoc comment for device_pm_wait_for_dev

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1064 bytes --]

On Fri 2019-03-15 23:48:41, Yangtao Li wrote:
> Rearrange comment to make the comment style consistent, the previous
> function parameters are described first.
> 
> Signed-off-by: Yangtao Li <tiny.windzz@gmail.com>

Acked-by: Pavel Machek <pavel@ucw.cz>

> ---
>  drivers/base/power/main.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/base/power/main.c b/drivers/base/power/main.c
> index 0cff68bd7b4b..eddb54057ed6 100644
> --- a/drivers/base/power/main.c
> +++ b/drivers/base/power/main.c
> @@ -2069,8 +2069,8 @@ EXPORT_SYMBOL_GPL(__suspend_report_result);
>  
>  /**
>   * device_pm_wait_for_dev - Wait for suspend/resume of a device to complete.
> - * @dev: Device to wait for.
>   * @subordinate: Device that needs to wait for @dev.
> + * @dev: Device to wait for.
>   */
>  int device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
>  {

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCH] PM / core: fix kerneldoc comment for device_pm_wait_for_dev

[Rafael J. Wysocki]

On Monday, March 18, 2019 1:17:10 PM CEST Pavel Machek wrote:
> 
> --Qf1oXS95uex85X0R
> Content-Type: text/plain; charset=us-ascii
> Content-Disposition: inline
> Content-Transfer-Encoding: quoted-printable
> 
> On Fri 2019-03-15 23:48:41, Yangtao Li wrote:
> > Rearrange comment to make the comment style consistent, the previous
> > function parameters are described first.
> >=20
> > Signed-off-by: Yangtao Li <tiny.windzz@gmail.com>
> 
> Acked-by: Pavel Machek <pavel@ucw.cz>

Patch applied, thanks!