Re: [PATCH] docs: refcount_t documentation

From: Kees Cook
Date: Mon Dec 11 2017 - 17:17:17 EST


On Mon, Dec 11, 2017 at 1:42 PM, Jonathan Corbet <corbet@xxxxxxx> wrote:
> On Tue, 5 Dec 2017 12:46:35 +0200
> Elena Reshetova <elena.reshetova@xxxxxxxxx> wrote:
>
>> Some functions from refcount_t API provide different
>> memory ordering guarantees that their atomic counterparts.
>> This adds a document outlining these differences (
>> Documentation/core-api/refcount-vs-atomic.rst) as well as
>> some other minor improvements.
>
> I've applied this, thanks, it looks good.
>
> One thing I noticed, though, is that this landed in the core-api manual,
> while the refcount_t documentation is in the driver-api manual. The
> cross-references work just fine and such, but this still doesn't seem quite
> right. Probably what should be done is to have all the refcount_t
> material in core-api; I may do that if I get a moment.

I did notice that, yeah. It seemed like a bunch of kernel-doc was
living in the driver-api manual, where it should be in core. Since
atomics were already there, I put refcount_t there...

-Kees

--
Kees Cook
Pixel Security