On Tue, Apr 23, 2019 at 11:53:49AM -0600, Jonathan Corbet wrote:
Look at crap like this:
"The memory allocations via :c:func:`kmalloc`, :c:func:`vmalloc`, :c:func:`kmem_cache_alloc` and"
That should've been written like:
"The memory allocations via kmalloc(), vmalloc(), kmem_cache_alloc() and"
Yeah, I get it. That markup generates cross-references, which can be seriously useful for readers - we want that.
The funny thing is; that sentence continues (on a new line) like:
"friends are traced and the pointers, together with additional"
So while it then has cross-references to a few functions, all 'friends' are left dangling. So what's the point of the cross-references?
Also, 'make ctags' and follow tag (ctrl-] for fellow vim users) will get you to the function, no magic markup required.
But I do wonder if we couldn't do it automatically with just a little bit of scripting work. It's not to hard to recognize this_is_a_function(), after all. I'll look into that, it would definitely help to remove some gunk from the source docs.
That would be good; less markup is more.