Follow @Openwall on Twitter for new release announcements and other news
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date: Mon, 29 Oct 2018 21:28:12 +0200
From: Igor Stoppa <>
To: Matthew Wilcox <>,
 Peter Zijlstra <>
Cc: Mimi Zohar <>, Kees Cook <>,
 Dave Chinner <>, James Morris <>,
 Michal Hocko <>,,,,, Dave Hansen <>,
 Jonathan Corbet <>, Laura Abbott <>,
 Randy Dunlap <>, Mike Rapoport
Subject: Re: [PATCH 10/17] prmem: documentation

On 26/10/2018 11:20, Matthew Wilcox wrote:
> On Fri, Oct 26, 2018 at 11:26:09AM +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.
>> 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


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.