Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Sat, 22 Jun 2019 18:58:44 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To:     =?UTF-8?B?QW5kcsOp?= Almeida <andrealmeid@collabora.com>
Cc:     linux-media@vger.kernel.org, hverkuil@xs4all.nl,
        helen.koike@collabora.com, kernel@collabora.com,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 1/2] media: vimc: stream: add missing function
 documentation
Message-ID: <20190622185844.4b2392a3@coco.lan>
In-Reply-To: <c9602b72-7dbb-47ad-97ef-9348d7e1c3e9@collabora.com>
References: <20190617133221.21246-1-andrealmeid@collabora.com>
        <20190621181705.44415597@coco.lan>
        <c9602b72-7dbb-47ad-97ef-9348d7e1c3e9@collabora.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Em Sat, 22 Jun 2019 18:51:06 -0300
Andr=C3=A9 Almeida <andrealmeid@collabora.com> escreveu:

> Hello Mauro,
>=20
> On 6/21/19 6:17 PM, Mauro Carvalho Chehab wrote:
> > Em Mon, 17 Jun 2019 10:32:20 -0300
> > Andr=C3=A9 Almeida <andrealmeid@collabora.com> escreveu:
> > =20
> >> Add comments at vimc_streamer_s_stream and vimc_streamer_thread, making
> >> the vimc-stream totally documented. =20
> > I'm applying it right now.
> >
> > Yet, if this is fully documented, IMO you should add it to
> > Documentation/media/v4l-drivers, replacing the comments to kernel-doc
> > markups. =20
>=20
> This suggestion is a great improvement and it's simple to apply to the
> source. Where do you believe we can place this at[1]? Maybe something like
>=20
>=20
> Source code documentation
> -------------------------
>=20
> vimc-streamer
> ~~~~~~~~~~~~
>=20
> .. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c
>    :internal:
>=20
>=20
> at the end of the file?
>=20
Yeah, this should be enough.

> > That would make easier for the ones to read the comments and, if someone
> > changes a function call, warnings will be produced, and the developer
> > will be warned.
> > Thanks,
> > Mauro =20
>=20
> Thanks,
> =C2=A0=C2=A0=C2=A0 Andr=C3=A9
>=20
> [1]
> https://git.linuxtv.org/media_tree.git/tree/Documentation/media/v4l-drive=
rs/vimc.rst
>=20


Thanks,
Mauro