Re: [PATCH 10/17] prmem: documentation

From: Igor Stoppa
Date: Mon Oct 29 2018 - 15:28:20 EST

On 26/10/2018 11:20, Matthew Wilcox wrote:
On Fri, Oct 26, 2018 at 11:26:09AM +0200, Peter Zijlstra wrote:

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

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 think Igor neglected to read doc-guide/sphinx.rst:

Guilty as charged :-/

Specific guidelines for the kernel documentation

Here are some specific guidelines for the kernel documentation:

* Please don't go overboard with reStructuredText markup. Keep it
simple. For the most part the documentation should be plain text with
just enough consistency in formatting that it can be converted to
other formats.

I agree that it's overly marked up.

I'll fix it