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: <c9602b72-7dbb-47ad-97ef-9348d7e1c3e9@collabora.com>
Date:   Sat, 22 Jun 2019 18:51:06 -0300
From:   André Almeida <andrealmeid@...labora.com>
To:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
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

Hello Mauro,

On 6/21/19 6:17 PM, Mauro Carvalho Chehab wrote:
> 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.

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


Source code documentation
-------------------------

vimc-streamer
~~~~~~~~~~~~

.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c
   :internal:


at the end of the file?

> 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

Thanks,
    André

[1]
https://git.linuxtv.org/media_tree.git/tree/Documentation/media/v4l-drivers/vimc.rst