diff mbox series

[3/7] PM: runtime: remove kernel-doc warnings

Message ID 20210331232614.304591-4-pierre-louis.bossart@linux.intel.com (mailing list archive)
State Awaiting Upstream
Delegated to: Rafael Wysocki
Headers show
Series None | expand

Commit Message

Pierre-Louis Bossart March 31, 2021, 11:26 p.m. UTC
remove make W=1 warnings

drivers/base/power/runtime.c:926: warning: Function parameter or
member 'timer' not described in 'pm_suspend_timer_fn'

drivers/base/power/runtime.c:926: warning: Excess function parameter
'data' description in 'pm_suspend_timer_fn'

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 drivers/base/power/runtime.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rafael J. Wysocki April 1, 2021, 1:40 p.m. UTC | #1
On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
<pierre-louis.bossart@linux.intel.com> wrote:
>
> remove make W=1 warnings
>
> drivers/base/power/runtime.c:926: warning: Function parameter or
> member 'timer' not described in 'pm_suspend_timer_fn'
>
> drivers/base/power/runtime.c:926: warning: Excess function parameter
> 'data' description in 'pm_suspend_timer_fn'
>
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> ---
>  drivers/base/power/runtime.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> index fe1dad68aee4..1fc1a992f90c 100644
> --- a/drivers/base/power/runtime.c
> +++ b/drivers/base/power/runtime.c
> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
>
>  /**
>   * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> - * @data: Device pointer passed by pm_schedule_suspend().
> + * @timer: hrtimer used by pm_schedule_suspend().
>   *
>   * Check if the time is right and queue a suspend request.
>   */
> --

I can apply this along with the [4-5/7].  Do you want me to do that?
Pierre-Louis Bossart April 1, 2021, 2:13 p.m. UTC | #2
On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> <pierre-louis.bossart@linux.intel.com> wrote:
>>
>> remove make W=1 warnings
>>
>> drivers/base/power/runtime.c:926: warning: Function parameter or
>> member 'timer' not described in 'pm_suspend_timer_fn'
>>
>> drivers/base/power/runtime.c:926: warning: Excess function parameter
>> 'data' description in 'pm_suspend_timer_fn'
>>
>> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
>> ---
>>   drivers/base/power/runtime.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
>> index fe1dad68aee4..1fc1a992f90c 100644
>> --- a/drivers/base/power/runtime.c
>> +++ b/drivers/base/power/runtime.c
>> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
>>
>>   /**
>>    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
>> - * @data: Device pointer passed by pm_schedule_suspend().
>> + * @timer: hrtimer used by pm_schedule_suspend().
>>    *
>>    * Check if the time is right and queue a suspend request.
>>    */
>> --
> 
> I can apply this along with the [4-5/7].  Do you want me to do that?

Works for me. I wasn't sure by looking at the MAINTAINERS file which 
files in drivers/base/ are maintained by whom, so sent the patches as a 
single set.
Greg KH April 2, 2021, 2:24 p.m. UTC | #3
On Thu, Apr 01, 2021 at 09:13:18AM -0500, Pierre-Louis Bossart wrote:
> 
> 
> On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> > On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> > <pierre-louis.bossart@linux.intel.com> wrote:
> > > 
> > > remove make W=1 warnings
> > > 
> > > drivers/base/power/runtime.c:926: warning: Function parameter or
> > > member 'timer' not described in 'pm_suspend_timer_fn'
> > > 
> > > drivers/base/power/runtime.c:926: warning: Excess function parameter
> > > 'data' description in 'pm_suspend_timer_fn'
> > > 
> > > Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> > > ---
> > >   drivers/base/power/runtime.c | 2 +-
> > >   1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> > > index fe1dad68aee4..1fc1a992f90c 100644
> > > --- a/drivers/base/power/runtime.c
> > > +++ b/drivers/base/power/runtime.c
> > > @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
> > > 
> > >   /**
> > >    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> > > - * @data: Device pointer passed by pm_schedule_suspend().
> > > + * @timer: hrtimer used by pm_schedule_suspend().
> > >    *
> > >    * Check if the time is right and queue a suspend request.
> > >    */
> > > --
> > 
> > I can apply this along with the [4-5/7].  Do you want me to do that?
> 
> Works for me. I wasn't sure by looking at the MAINTAINERS file which files
> in drivers/base/ are maintained by whom, so sent the patches as a single
> set.

That's fine, we can work it out :)
Rafael J. Wysocki April 7, 2021, 5:23 p.m. UTC | #4
On Thu, Apr 1, 2021 at 4:13 PM Pierre-Louis Bossart
<pierre-louis.bossart@linux.intel.com> wrote:
>
>
>
> On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> > On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> > <pierre-louis.bossart@linux.intel.com> wrote:
> >>
> >> remove make W=1 warnings
> >>
> >> drivers/base/power/runtime.c:926: warning: Function parameter or
> >> member 'timer' not described in 'pm_suspend_timer_fn'
> >>
> >> drivers/base/power/runtime.c:926: warning: Excess function parameter
> >> 'data' description in 'pm_suspend_timer_fn'
> >>
> >> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> >> ---
> >>   drivers/base/power/runtime.c | 2 +-
> >>   1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> >> index fe1dad68aee4..1fc1a992f90c 100644
> >> --- a/drivers/base/power/runtime.c
> >> +++ b/drivers/base/power/runtime.c
> >> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
> >>
> >>   /**
> >>    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> >> - * @data: Device pointer passed by pm_schedule_suspend().
> >> + * @timer: hrtimer used by pm_schedule_suspend().
> >>    *
> >>    * Check if the time is right and queue a suspend request.
> >>    */
> >> --
> >
> > I can apply this along with the [4-5/7].  Do you want me to do that?
>
> Works for me. I wasn't sure by looking at the MAINTAINERS file which
> files in drivers/base/ are maintained by whom, so sent the patches as a
> single set.

All three applied now as 5.13 material, thanks!
diff mbox series

Patch

diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
index fe1dad68aee4..1fc1a992f90c 100644
--- a/drivers/base/power/runtime.c
+++ b/drivers/base/power/runtime.c
@@ -951,7 +951,7 @@  static void pm_runtime_work(struct work_struct *work)
 
 /**
  * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
- * @data: Device pointer passed by pm_schedule_suspend().
+ * @timer: hrtimer used by pm_schedule_suspend().
  *
  * Check if the time is right and queue a suspend request.
  */