linux-kernel - Re: Kernel docs: muddying the waters a bit

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20160217151401.3cb82f65@lwn.net>
Date:	Wed, 17 Feb 2016 15:14:01 -0700
From:	Jonathan Corbet <corbet@....net>
To:	Daniel Vetter <daniel.vetter@...ll.ch>
Cc:	Keith Packard <keithp@...thp.com>,
	LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org,
	Jani Nikula <jani.nikula@...el.com>
Subject: Re: Kernel docs: muddying the waters a bit

On Sun, 14 Feb 2016 13:27:04 +0100
Daniel Vetter <daniel.vetter@...ll.ch> wrote:

> One concern/open I have for pro/cons are the hyperlinks from kerneldoc
> comments. Currently we have the postproc hack, iirc Jani's patches
> generated links native when extracting the kerneldoc. What's the
> solution with spinx?

So I've been trying to figure out what this refers to.  Is this the
cross-reference links within the document?  When I did my sphinx hack it
used a technique that, shall we say, strongly resembles what Jani's
patches did.  One difference is that Sphinx has the concept of
"functions" built into it, so I use function references for those.

If you mean links to the wider world, I'm not sure I see that in Jani's
patches.  It's going to be easily managed in whatever markup language we
use, though.

jon