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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <B60D13B1-AFE9-4126-B9C0-082AE33B3427@darmarit.de>
Date:	Wed, 15 Jun 2016 15:01:06 +0200
From:	Markus Heiser <markus.heiser@...marit.de>
To:	Daniel Vetter <daniel.vetter@...ll.ch>
Cc:	Jonathan Corbet <corbet@....net>,
	Jani Nikula <jani.nikula@...el.com>,
	Grant Likely <grant.likely@...retlab.ca>,
	Mauro Carvalho Chehab <mchehab@....samsung.com>,
	Keith Packard <keithp@...thp.com>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	linux-doc@...r.kernel.org, Hans Verkuil <hverkuil@...all.nl>
Subject: Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

FYI

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

> On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.heiser@...marit.de> wrote:
>> From: "Heiser, Markus" <markus.heiser@...marIT.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--