[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date: Fri, 26 Oct 2018 13:09:08 +0200
From: Markus Heiser <markus.heiser@...marit.de>
To: Peter Zijlstra <peterz@...radead.org>, Igor Stoppa <igor.stoppa@...il.com>
Cc: 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>, Jonathan Corbet <corbet@....net>,
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
Am 26.10.18 um 11:26 schrieb Peter Zijlstra:
>> 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:
>
> 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.
To add my two cent ..
> WTH is with all those ** ?
I guess Igor was looking for a definition list ...
>> +Available protections for kernel data
>> +-------------------------------------
>> +
>> +- **constant**
>> + Labelled as **const**, the data is never supposed to be altered.
>> + It is statically allocated - if it has any memory footprint at all.
>> + The compiler can even optimize it away, where possible, by replacing
>> + references to a **const** with its actual value.
+Available protections for kernel data
+-------------------------------------
+
+constant
+ Labelled as const, the data is never supposed to be altered.
+ It is statically allocated - if it has any memory footprint at all.
+ The compiler can even optimize it away, where possible, by replacing
+ references to a const with its actual value.
see "Lists and Quote-like blocks" [1]
[1]
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks
-- Markus --
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.
