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:   Mon, 24 Jun 2019 06:40:04 -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 3/5] media: vimc: stream: format comments as kernel-doc
Message-ID: <20190624064004.224cccfb@coco.lan>
In-Reply-To: <a1973442-5ccb-5ba3-e508-132514b6e83e@collabora.com>
References: <20190623164024.9836-1-andrealmeid@collabora.com>
        <20190623164024.9836-3-andrealmeid@collabora.com>
        <a1973442-5ccb-5ba3-e508-132514b6e83e@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 Sun, 23 Jun 2019 18:27:22 -0300
Andr=C3=A9 Almeida <andrealmeid@collabora.com> escreveu:

> On 6/23/19 1:40 PM, Andr=C3=A9 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 o=
f =20
> ``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=C2=A0 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=20
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