linux-kernel - Re: [PATCH v3 1/2] media: vimc: stream: add missing function documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190621181705.44415597@coco.lan>
Date:   Fri, 21 Jun 2019 18:17:05 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     André Almeida <andrealmeid@...labora.com>
Cc:     linux-media@...r.kernel.org, hverkuil@...all.nl,
        helen.koike@...labora.com, kernel@...labora.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 1/2] media: vimc: stream: add missing function
 documentation

Em Mon, 17 Jun 2019 10:32:20 -0300
André Almeida <andrealmeid@...labora.com> escreveu:

> Add comments at vimc_streamer_s_stream and vimc_streamer_thread, making
> the vimc-stream totally documented.

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.

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