Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1423000

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

From Markus Heiser <markus.heiser@darmarit.de>
Newsgroups linux.kernel
Subject Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation
Date 2016-06-15 15:10 +0200
Message-ID <rKiJY-2Ya-23@gated-at.bofh.it> (permalink)
References <rH5Jf-7nV-3@gated-at.bofh.it> <rHk5A-8fO-13@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


FYI

Am 07.06.2016 um 09:54 schrieb Daniel Vetter <daniel.vetter@ffwll.ch>:

> On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.heiser@darmarit.de> wrote:
>> From: "Heiser, Markus" <markus.heiser@darmarIT.de>
>> 
> I'm still not sold on the vintage-kerneldoc idea. At least in my
> experience (after first converting to asciidoc and now to sphinx) this
> is a non-issue. Yes, there's the oddball misrendering, but that's no
> worse than the oddball typo.

Since *vintage* and reST mode is an option of the ".. kernel-doc:" 
directive it is compareabel. E.g 80211.html produce markup errors:

* 230 in "reST" mode
* 6 in *vintage* "kernel-doc" mode

95% of the errors caused by:

    Emphasis “*”: like *emphasis* or **emphasis strong**
    Leading “_” : is a anchor in reST markup (_foo).
    Trailing “_: is a reference in reST markup (foo_).
    interpreted text: “`”
    inline literals: “``”
    substitution references: “|”

which qouted when the parser runs in vintage "kernel-doc" mode.

--Markus--
 

Back to linux.kernel | Previous | Next | Find similar | Unroll thread


Thread

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation Markus Heiser <markus.heiser@darmarit.de> - 2016-06-15 15:10 +0200

csiph-web