[lkml]   [2018]   [Oct]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: [PATCH 10/17] prmem: documentation
On Fri, 26 Oct 2018 11:26:09 +0200
Peter Zijlstra <> wrote:

> Jon,
> So the below document is a prime example for why I think RST sucks. As a
> text document readability is greatly diminished by all the markup
> nonsense.

Please don't confused RST with the uses of it. The fact that one can do
amusing things with the C preprocessor doesn't, on its own, make C
> This stuff should not become write-only content like html and other
> gunk. The actual text file is still the primary means of reading this.

I agree that the text file comes first, and I agree that the markup in
this particular document is excessive.

Igor, just like #ifdef's make code hard to read, going overboard with RST
markup makes text hard to read. It's a common trap to fall into, because
it lets you make slick-looking web pages, but that is not our primary
goal here. Many thanks for writing documentation for this feature, that
already puts you way ahead of a discouraging number of contributors. But
could I ask you, please, to make a pass over it and reduce the markup to
a minimum? Using lists as suggested by Markus would help here.



 \ /
  Last update: 2018-10-26 17:05    [W:0.172 / U:26.332 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site