[v1,01/17] media: camss: Fix comment using wrong function name

Message ID 20210108120429.895046-2-robert.foss@linaro.org
State New
Headers show
Series
  • Add support for SDM845 Camera Subsystem
Related show

Commit Message

Robert Foss Jan. 8, 2021, 12:04 p.m.
Function name is comment is wrong, and was changed to be
the same as the actual function name.

Signed-off-by: Robert Foss <robert.foss@linaro.org>

---
 drivers/media/platform/qcom/camss/camss-vfe.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.27.0

Comments

Robert Foss Jan. 13, 2021, 10:04 a.m. | #1
Thanks Björn!

On Fri, 8 Jan 2021 at 19:51, Bjorn Andersson <bjorn.andersson@linaro.org> wrote:
>
> On Fri 08 Jan 06:04 CST 2021, Robert Foss wrote:
>
> > Function name is comment is wrong, and was changed to be
> > the same as the actual function name.
> >
> > Signed-off-by: Robert Foss <robert.foss@linaro.org>
> > ---
> >  drivers/media/platform/qcom/camss/camss-vfe.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/media/platform/qcom/camss/camss-vfe.c b/drivers/media/platform/qcom/camss/camss-vfe.c
> > index fae2b513b2f9..478be4f0cab5 100644
> > --- a/drivers/media/platform/qcom/camss/camss-vfe.c
> > +++ b/drivers/media/platform/qcom/camss/camss-vfe.c
> > @@ -1077,7 +1077,7 @@ static void vfe_isr_wm_done(struct vfe_device *vfe, u8 wm)
> >  }
> >
> >  /*
> > - * vfe_isr_wm_done - Process composite image done interrupt
> > + * vfe_isr_comp_done - Process composite image done interrupt
>
> It's a function, so it should be "vfe_isr_comp_done()", but unless the
> comment is denoted kerneldoc by starting with '/' followed by two '*' it
> "doesn't matter".
>
> As a matter of fact, none of the kerneldoc in this file has the proper
> '/**' start, so this file is "undocumented".
>
> So please add another '*' and some () throughout the file.

Ack

>
> Regards,
> Bjorn
>
> >   * @vfe: VFE Device
> >   * @comp: Composite image id
> >   */
> > --
> > 2.27.0
> >

Patch

diff --git a/drivers/media/platform/qcom/camss/camss-vfe.c b/drivers/media/platform/qcom/camss/camss-vfe.c
index fae2b513b2f9..478be4f0cab5 100644
--- a/drivers/media/platform/qcom/camss/camss-vfe.c
+++ b/drivers/media/platform/qcom/camss/camss-vfe.c
@@ -1077,7 +1077,7 @@  static void vfe_isr_wm_done(struct vfe_device *vfe, u8 wm)
 }
 
 /*
- * vfe_isr_wm_done - Process composite image done interrupt
+ * vfe_isr_comp_done - Process composite image done interrupt
  * @vfe: VFE Device
  * @comp: Composite image id
  */