linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning
@ 2019-09-18 12:22 Fabrice Gasnier
  2019-09-25 23:49 ` William Breathitt Gray
  0 siblings, 1 reply; 4+ messages in thread
From: Fabrice Gasnier @ 2019-09-18 12:22 UTC (permalink / raw)
  To: vilhelm.gray
  Cc: jic23, alexandre.torgue, fabrice.gasnier, linux-iio, linux-stm32,
	linux-arm-kernel, linux-kernel

Fix the following warning when documentation is built:
drivers/counter/stm32-timer-cnt.c:37: warning: cannot understand function
prototype: 'enum stm32_count_function'

Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
---
 drivers/counter/stm32-timer-cnt.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/counter/stm32-timer-cnt.c b/drivers/counter/stm32-timer-cnt.c
index 644ba18..e425dd1 100644
--- a/drivers/counter/stm32-timer-cnt.c
+++ b/drivers/counter/stm32-timer-cnt.c
@@ -28,7 +28,7 @@ struct stm32_timer_cnt {
 };
 
 /**
- * stm32_count_function - enumerates stm32 timer counter encoder modes
+ * enum stm32_count_function - enumerates stm32 timer counter encoder modes
  * @STM32_COUNT_SLAVE_MODE_DISABLED: counts on internal clock when CEN=1
  * @STM32_COUNT_ENCODER_MODE_1: counts TI1FP1 edges, depending on TI2FP2 level
  * @STM32_COUNT_ENCODER_MODE_2: counts TI2FP2 edges, depending on TI1FP1 level
-- 
2.7.4


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning
  2019-09-18 12:22 [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning Fabrice Gasnier
@ 2019-09-25 23:49 ` William Breathitt Gray
  2019-09-25 23:53   ` William Breathitt Gray
  0 siblings, 1 reply; 4+ messages in thread
From: William Breathitt Gray @ 2019-09-25 23:49 UTC (permalink / raw)
  To: Fabrice Gasnier, jic23
  Cc: jic23, alexandre.torgue, linux-iio, linux-stm32,
	linux-arm-kernel, linux-kernel

On Wed, Sep 18, 2019 at 02:22:03PM +0200, Fabrice Gasnier wrote:
> Fix the following warning when documentation is built:
> drivers/counter/stm32-timer-cnt.c:37: warning: cannot understand function
> prototype: 'enum stm32_count_function'
> 
> Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> ---
>  drivers/counter/stm32-timer-cnt.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/counter/stm32-timer-cnt.c b/drivers/counter/stm32-timer-cnt.c
> index 644ba18..e425dd1 100644
> --- a/drivers/counter/stm32-timer-cnt.c
> +++ b/drivers/counter/stm32-timer-cnt.c
> @@ -28,7 +28,7 @@ struct stm32_timer_cnt {
>  };
>  
>  /**
> - * stm32_count_function - enumerates stm32 timer counter encoder modes
> + * enum stm32_count_function - enumerates stm32 timer counter encoder modes
>   * @STM32_COUNT_SLAVE_MODE_DISABLED: counts on internal clock when CEN=1
>   * @STM32_COUNT_ENCODER_MODE_1: counts TI1FP1 edges, depending on TI2FP2 level
>   * @STM32_COUNT_ENCODER_MODE_2: counts TI2FP2 edges, depending on TI1FP1 level
> -- 
> 2.7.4

Fixes: 597f55e3f36c ("counter: stm32-lptimer: add counter device")

Jonathan, please pick this fix up through IIO.

Thanks,

William Breathitt Gray

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning
  2019-09-25 23:49 ` William Breathitt Gray
@ 2019-09-25 23:53   ` William Breathitt Gray
  2019-10-05 14:28     ` Jonathan Cameron
  0 siblings, 1 reply; 4+ messages in thread
From: William Breathitt Gray @ 2019-09-25 23:53 UTC (permalink / raw)
  To: Fabrice Gasnier, jic23
  Cc: jic23, alexandre.torgue, linux-iio, linux-stm32,
	linux-arm-kernel, linux-kernel

On Wed, Sep 25, 2019 at 07:49:27PM -0400, William Breathitt Gray wrote:
> On Wed, Sep 18, 2019 at 02:22:03PM +0200, Fabrice Gasnier wrote:
> > Fix the following warning when documentation is built:
> > drivers/counter/stm32-timer-cnt.c:37: warning: cannot understand function
> > prototype: 'enum stm32_count_function'
> > 
> > Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> > ---
> >  drivers/counter/stm32-timer-cnt.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/counter/stm32-timer-cnt.c b/drivers/counter/stm32-timer-cnt.c
> > index 644ba18..e425dd1 100644
> > --- a/drivers/counter/stm32-timer-cnt.c
> > +++ b/drivers/counter/stm32-timer-cnt.c
> > @@ -28,7 +28,7 @@ struct stm32_timer_cnt {
> >  };
> >  
> >  /**
> > - * stm32_count_function - enumerates stm32 timer counter encoder modes
> > + * enum stm32_count_function - enumerates stm32 timer counter encoder modes
> >   * @STM32_COUNT_SLAVE_MODE_DISABLED: counts on internal clock when CEN=1
> >   * @STM32_COUNT_ENCODER_MODE_1: counts TI1FP1 edges, depending on TI2FP2 level
> >   * @STM32_COUNT_ENCODER_MODE_2: counts TI2FP2 edges, depending on TI1FP1 level
> > -- 
> > 2.7.4
> 
> Fixes: 597f55e3f36c ("counter: stm32-lptimer: add counter device")
> 
> Jonathan, please pick this fix up through IIO.
> 
> Thanks,
> 
> William Breathitt Gray

Sorry, that's the wrong Fixes line. Here's the right one:

Fixes: ad29937e206f ("counter: Add STM32 Timer quadrature encoder")

William Breathitt Gray

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning
  2019-09-25 23:53   ` William Breathitt Gray
@ 2019-10-05 14:28     ` Jonathan Cameron
  0 siblings, 0 replies; 4+ messages in thread
From: Jonathan Cameron @ 2019-10-05 14:28 UTC (permalink / raw)
  To: William Breathitt Gray
  Cc: Fabrice Gasnier, jic23, alexandre.torgue, linux-iio, linux-stm32,
	linux-arm-kernel, linux-kernel

On Wed, 25 Sep 2019 19:53:10 -0400
William Breathitt Gray <vilhelm.gray@gmail.com> wrote:

> On Wed, Sep 25, 2019 at 07:49:27PM -0400, William Breathitt Gray wrote:
> > On Wed, Sep 18, 2019 at 02:22:03PM +0200, Fabrice Gasnier wrote:  
> > > Fix the following warning when documentation is built:
> > > drivers/counter/stm32-timer-cnt.c:37: warning: cannot understand function
> > > prototype: 'enum stm32_count_function'
> > > 
> > > Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> > > ---
> > >  drivers/counter/stm32-timer-cnt.c | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/drivers/counter/stm32-timer-cnt.c b/drivers/counter/stm32-timer-cnt.c
> > > index 644ba18..e425dd1 100644
> > > --- a/drivers/counter/stm32-timer-cnt.c
> > > +++ b/drivers/counter/stm32-timer-cnt.c
> > > @@ -28,7 +28,7 @@ struct stm32_timer_cnt {
> > >  };
> > >  
> > >  /**
> > > - * stm32_count_function - enumerates stm32 timer counter encoder modes
> > > + * enum stm32_count_function - enumerates stm32 timer counter encoder modes
> > >   * @STM32_COUNT_SLAVE_MODE_DISABLED: counts on internal clock when CEN=1
> > >   * @STM32_COUNT_ENCODER_MODE_1: counts TI1FP1 edges, depending on TI2FP2 level
> > >   * @STM32_COUNT_ENCODER_MODE_2: counts TI2FP2 edges, depending on TI1FP1 level
> > > -- 
> > > 2.7.4  
> > 
> > Fixes: 597f55e3f36c ("counter: stm32-lptimer: add counter device")
> > 
> > Jonathan, please pick this fix up through IIO.
> > 
> > Thanks,
> > 
> > William Breathitt Gray  
> 
> Sorry, that's the wrong Fixes line. Here's the right one:
> 
> Fixes: ad29937e206f ("counter: Add STM32 Timer quadrature encoder")
> 
> William Breathitt Gray
I've picked it up, but please be more formal and also give an
Acked-by: in future.

Applied to the togreg branch of iio.git and pushed out as testing though
I doubt automatic testing of kernel-doc is occurring.

Thanks,

Jonathan



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2019-10-05 14:28 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-18 12:22 [PATCH] counter: stm32-timer-cnt: fix a kernel-doc warning Fabrice Gasnier
2019-09-25 23:49 ` William Breathitt Gray
2019-09-25 23:53   ` William Breathitt Gray
2019-10-05 14:28     ` Jonathan Cameron

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).