Message ID | 1568809323-26079-1-git-send-email-fabrice.gasnier@st.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | counter: stm32-timer-cnt: fix a kernel-doc warning | expand |
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
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
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
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
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(-)