On Tue, Aug 02, 2022 at 02:42:22PM +0200, Ricardo Ca?uelo wrote:> +In this case, when the interrupt arrives :c:func:`vp_interrupt` will be > +called and it will ultimately lead to a call to > +:c:func:`vring_interrupt`, which ends up calling the virtqueue callback > +function::You don't need to use :c:func:`foo`. You can just write foo() and the tooling will convert it into :c:func:`foo` for you.
Matthew Wilcox <willy at infradead.org> writes:> On Tue, Aug 02, 2022 at 02:42:22PM +0200, Ricardo Ca?uelo wrote: >> +In this case, when the interrupt arrives :c:func:`vp_interrupt` will be >> +called and it will ultimately lead to a call to >> +:c:func:`vring_interrupt`, which ends up calling the virtqueue callback >> +function:: > > You don't need to use :c:func:`foo`. You can just write foo() and the > tooling will convert it into :c:func:`foo` for you.
Hi Matthew, On mar, ago 02 2022 at 16:56:48, Matthew Wilcox <willy at infradead.org> wrote:> You don't need to use :c:func:`foo`. You can just write foo() and the > tooling will convert it into :c:func:`foo` for you.Thanks for the tip. However, I did some tests and the results aren't quite the same. For functions with kerneldocs that are referenced in the same document (.. kernel-doc::) the tool does efectively link to the generated documentation, but for all the other functions using c:func:`foo` generates a different formatting than `foo`, which does no formatting at all. I don't know if the extra semantic info can be used by the tooling in any other way, in case it doesn't the fancy formatting might not be worth it in exchange for a noisier source text, but I've seen it been used in other driver-api docs. Cheers, Ricardo