Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210108120429.895046-1-robert.foss@linaro.org>
 <20210108120429.895046-2-robert.foss@linaro.org> <X/ippoemGT9d28Sd@builder.lan>
In-Reply-To: <X/ippoemGT9d28Sd@builder.lan>
From:   Robert Foss <robert.foss@linaro.org>
Date:   Wed, 13 Jan 2021 11:04:24 +0100
Message-ID: <CAG3jFyv4Bnk1c0fm3wQ5CkXA9POEXM1JbmE4SqAFQ23hBvftBw@mail.gmail.com>
Subject: Re: [PATCH v1 01/17] media: camss: Fix comment using wrong function name
To:     Bjorn Andersson <bjorn.andersson@linaro.org>
Cc:     Andy Gross <agross@kernel.org>, Todor Tomov <todor.too@gmail.com>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        Rob Herring <robh+dt@kernel.org>, catalin.marinas@arm.com,
        will@kernel.org, shawnguo@kernel.org, leoyang.li@nxp.com,
        geert+renesas@glider.be, arnd@arndb.de, Anson.Huang@nxp.com,
        michael@walle.cc, agx@sigxcpu.org, max.oss.09@gmail.com,
        linux-arm-msm@vger.kernel.org,
        linux-media <linux-media@vger.kernel.org>,
        "open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS" 
        <devicetree@vger.kernel.org>,
        linux-kernel <linux-kernel@vger.kernel.org>,
        "moderated list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE" 
        <linux-arm-kernel@lists.infradead.org>,
        AngeloGioacchino Del Regno <kholk11@gmail.com>,
        Andrey Konovalov <andrey.konovalov@linaro.org>,
        Tomasz Figa <tfiga@chromium.org>,
        Azam Sadiq Pasha Kapatrala Syed <akapatra@quicinc.com>,
        Sarvesh Sridutt <Sarvesh.Sridutt@smartwirelesscompute.com>,
        Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

Thanks Bj=C3=B6rn!

On Fri, 8 Jan 2021 at 19:51, Bjorn Andersson <bjorn.andersson@linaro.org> w=
rote:
>
> 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/me=
dia/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 *vf=
e, 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
> >