[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <CAEXv5_gnnD0ez-_odAdowXUXNdA9F6XJ9OoT55CXoFUk4yDVyg@mail.gmail.com>
Date: Mon, 6 Feb 2017 16:05:49 -0500
From: David Windsor <dwindsor@...il.com>
To: Jonathan Corbet <corbet@....net>
Cc: Kees Cook <keescook@...omium.org>, Mark Rutland <mark.rutland@....com>,
Greg KH <gregkh@...uxfoundation.org>,
"kernel-hardening@...ts.openwall.com" <kernel-hardening@...ts.openwall.com>,
"Reshetova, Elena" <elena.reshetova@...el.com>, Hans Liljestrand <ishkamiel@...il.com>,
Peter Zijlstra <peterz@...radead.org>
Subject: Re: HARDENED_ATOMIC documentation
On Mon, Feb 6, 2017 at 3:51 PM, Jonathan Corbet <corbet@....net> wrote:
> On Mon, 6 Feb 2017 15:36:10 -0500
> David Windsor <dwindsor@...il.com> wrote:
>
>> Understood. I'll take the API reference I just created on kernsec.org
>> and move its contents to Documentation/core-api/refcount_ops.rst.
>> Then, update Documentation/security/self-protection.txt with some
>> language about this feature's justification, etc. and point to
>> refcount_ops.rst.
>
> This all sounds good, but the low-level API documentation is best done as
> kerneldoc comments with the actual definitions of the functions. You can
> then use the appropriate directives to pull it into the RST documentation.
>
> Details in Documentation/doc-guide/ if you need them.
>
Even better.
Objections, anyone?
> Thanks,
>
> jon
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.
