Thread (13 messages) 13 messages, 7 authors, 2019-04-23

Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst

From: Peter Zijlstra <hidden>
Date: 2019-04-23 17:12:29
Also in: dm-devel, dri-devel, linux-arch, linux-gpio, linux-iommu, linux-mm, platform-driver-x86

Possibly related (same subject, not in this thread)

On Tue, Apr 23, 2019 at 10:30:53AM -0600, Jonathan Corbet wrote:
On Tue, 23 Apr 2019 15:01:32 +0200
Peter Zijlstra [off-list ref] wrote:
quoted
But yes, I have 0 motivation to learn or abide by rst. It simply doesn't
give me anything in return. There is no upside, only worse text files :/
So I believe it gives even you one thing in return: documentation that is
more accessible for both readers and authors.
I know I'm an odd duck; but no. They're _less_ accessible for me, as
both a reader and author. They look 'funny' when read as a text file
(the only way it makes sense to read them; I spend 99% of my time on a
computer looking at monospace text interfaces; mutt, vim and console, in
that approximate order).

When writing, I now have to be bothered about this format crap over just
trying to write a coherent document.

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"

Heck, that paragraph isn't even properly flowed.

Then there's the endless stuck ':' key, and the mysterious "''" because
\" isn't a character, oh wait.

Bah..
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help