linux-kernel - Re: [PATCH 3/5] media: vimc: stream: format comments as kernel-doc

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]

Date:   Mon, 24 Jun 2019 06:40:04 -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 3/5] media: vimc: stream: format comments as kernel-doc

Em Sun, 23 Jun 2019 18:27:22 -0300
André Almeida <andrealmeid@...labora.com> escreveu:

> On 6/23/19 1:40 PM, André Almeida wrote:

> > - * Calls s_stream to enable stream in all entities of the pipeline.
> > + * Calls ``vimc_streamer_s_stream`` to enable stream in all entities of  
> ``vimc_streamer_s_stream`` could also been written as
> :c:func:`vimc_streamer_s_stream`. In this latest setup, the
> Documentation output would display a nice hyperlink to the documentation
> of  vimc_streamer_s_stream function. Is this a good improvement or it
> will be too verbose?

The best would be to use: vimc_streamer_s_stream(). Kernel-doc already
handles it (don't remember if it uses :c:func:, but I guess it does),
and this is the recommended way.

Anyway, there's a patch under discussion right now at Linux docs ML that 
will auto-replace these to :c:func`` automatically, not only on kernel-doc
tags, but also within the .rst files. It should be able to recognize
existing :c:func: tags, so no harm done if it is there somewhere.

Thanks,
Mauro