Re: [PATCH] media: cec.h: Fix kerneldoc

From: Ricardo Ribalda
Date: Fri May 03 2024 - 07:42:59 EST


On Fri, 3 May 2024 at 13:41, Hans Verkuil <hverkuil-cisco@xxxxxxxxx> wrote:
>
> On 03/05/2024 13:33, Ricardo Ribalda wrote:
> > is_claiming_log_addrs documentation was missing.
> >
> > fix this kernel-doc warning:
> > include/media/cec.h:296: warning: Function parameter or struct member 'is_claiming_log_addrs' not described in 'cec_adapter'
> >
> > Signed-off-by: Ricardo Ribalda <ribalda@xxxxxxxxxxxx>
>
> Reviewed-by: Hans Verkuil <hverkuil-cisco@xxxxxxxxx>
>
> Hmm, that happens when you don't run your own patches through the build tests :-(

There is an easy way to test your patches with gitlab. No need to
install anything in your computer :P

>
> Regards,
>
> Hans
>
> > ---
> > https://gitlab.freedesktop.org/linux-media/media-staging/-/pipelines/1169148/test_report?job_name=doc
> > ---
> > include/media/cec.h | 1 +
> > 1 file changed, 1 insertion(+)
> >
> > diff --git a/include/media/cec.h b/include/media/cec.h
> > index d3abe84c9c9e..d131514032f2 100644
> > --- a/include/media/cec.h
> > +++ b/include/media/cec.h
> > @@ -187,6 +187,7 @@ struct cec_adap_ops {
> > * in order to transmit or receive CEC messages. This is usually a HW
> > * limitation.
> > * @is_enabled: the CEC adapter is enabled
> > + * @is_claiming_log_addrs: true if cec_claim_log_addrs() is running
> > * @is_configuring: the CEC adapter is configuring (i.e. claiming LAs)
> > * @must_reconfigure: while configuring, the PA changed, so reclaim LAs
> > * @is_configured: the CEC adapter is configured (i.e. has claimed LAs)
> >
> > ---
> > base-commit: 1aa1329a67cc214c3b7bd2a14d1301a795760b07
> > change-id: 20240503-fixdoc-d1380eb243cd
> >
> > Best regards,
>


--
Ricardo Ribalda