netdev - Re: [PATCH 02/18] Documentation: document nospec helpers

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: <20180108141927.61427ad9@lwn.net>
Date:   Mon, 8 Jan 2018 14:19:27 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Mark Rutland <mark.rutland@....com>
Cc:     Dan Williams <dan.j.williams@...el.com>,
        linux-kernel@...r.kernel.org, linux-arch@...r.kernel.org,
        peterz@...radead.org, netdev@...r.kernel.org,
        Will Deacon <will.deacon@....com>, gregkh@...uxfoundation.org,
        tglx@...utronix.de, torvalds@...ux-foundation.org,
        alan@...ux.intel.com
Subject: Re: [PATCH 02/18] Documentation: document nospec helpers

On Mon, 8 Jan 2018 17:09:59 +0000
Mark Rutland <mark.rutland@....com> wrote:

> > I have just a couple of overall comments.
> > 
> >  - It would be nice if the document were done in RST and placed in the
> >    core-API manual, perhaps using kerneldoc comments for the macros
> >    themselves.  It's already 99.9% RST now, so the changes required would
> >    be minimal.  
> 
> Is there any quickstart guide to RST that you can recommend?

http://docutils.sourceforge.net/docs/user/rst/quickref.html works
reasonably well.  We have some info in the kernel documentation as well,
see http://static.lwn.net/kerneldoc/doc-guide/sphinx.html

Thanks,

jon