Re: [PATCH] docs: driver-api: virtio: virtio on Linux

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Matthew,

On mar, ago 02 2022 at 16:56:48, Matthew Wilcox <willy@xxxxxxxxxxxxx> 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
_______________________________________________
Virtualization mailing list
Virtualization@xxxxxxxxxxxxxxxxxxxxxxxxxx
https://lists.linuxfoundation.org/mailman/listinfo/virtualization



[Index of Archives]     [KVM Development]     [Libvirt Development]     [Libvirt Users]     [CentOS Virtualization]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux