On Tue, 23 Apr 2019 19:11:58 +0200 Peter Zijlstra peterz@infradead.org wrote:
When writing, I now have to be bothered about this format crap over just trying to write a coherent document.
Just write text, it'll all work out in the end :)
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. 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.
jon