Date: Fri, 26 Oct 2018 09:05:18 -0600 From: Jonathan Corbet <corbet@....net> To: Peter Zijlstra <peterz@...radead.org> Cc: Igor Stoppa <igor.stoppa@...il.com>, Mimi Zohar <zohar@...ux.vnet.ibm.com>, Kees Cook <keescook@...omium.org>, Matthew Wilcox <willy@...radead.org>, Dave Chinner <david@...morbit.com>, James Morris <jmorris@...ei.org>, Michal Hocko <mhocko@...nel.org>, kernel-hardening@...ts.openwall.com, linux-integrity@...r.kernel.org, linux-security-module@...r.kernel.org, igor.stoppa@...wei.com, Dave Hansen <dave.hansen@...ux.intel.com>, Laura Abbott <labbott@...hat.com>, Randy Dunlap <rdunlap@...radead.org>, Mike Rapoport <rppt@...ux.vnet.ibm.com>, linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org Subject: Re: [PATCH 10/17] prmem: documentation On Fri, 26 Oct 2018 11:26:09 +0200 Peter Zijlstra <peterz@...radead.org> 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 suck... > > 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. Thanks, jon
Powered by blists - more mailing lists
Confused about mailing lists and their use? Read about mailing lists on Wikipedia and check out these guidelines on proper formatting of your messages.