From: John Hubbard <jhubbard@nvidia.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>,
LKML <linux-kernel@vger.kernel.org>, <linux-mm@kvack.org>
Subject: Re: [PATCH 1/3] mm/gup: documentation corrections for gup/pup
Date: Sun, 8 Aug 2021 23:46:25 -0700 [thread overview]
Message-ID: <eaaa8340-d736-e6de-cce0-7d717bee7f7a@nvidia.com> (raw)
In-Reply-To: <YRCHZObkj/BJgCmR@casper.infradead.org>
On 8/8/21 6:39 PM, Matthew Wilcox wrote:
> On Sun, Aug 08, 2021 at 04:50:16PM -0700, John Hubbard wrote:
>> @@ -103,8 +103,14 @@ static inline struct page *try_get_compound_head(struct page *page, int refs)
>> * same time. (That's true throughout the get_user_pages*() and
>> * pin_user_pages*() APIs.) Cases:
>> *
>> - * FOLL_GET: page's refcount will be incremented by 1.
>> - * FOLL_PIN: page's refcount will be incremented by GUP_PIN_COUNTING_BIAS.
>> + * FOLL_GET: page's refcount will be incremented by refs.
>
> I think this would read more clearly if it said @refs (throughout).
OK, will change that for v2.
>
>> + *
>> + * FOLL_PIN on compound pages that are > two pages long: page's refcount will
>> + * be incremented by refs, and page[2].hpage_pinned_refcount will be
>> + * incremented by refs * GUP_PIN_COUNTING_BIAS.
>> + *
>> + * FOLL_PIN on normal pages, or compound pages that are two pages long:
>> + * page's refcount will be incremented by refs * GUP_PIN_COUNTING_BIAS.
>> *
>> * Return: head page (with refcount appropriately incremented) for success, or
>> * NULL upon failure. If neither FOLL_GET nor FOLL_PIN was set, that's
>
> Did you run 'make htmldocs' and see how it renders? I haven't looked,
> but this might work better as an rst list?
>
Hadn't occurred to me, due to my own incorrect mental separation between
comment kernel docs, and rst formatting ("rst == Documentation/"). I'll give it a try.
thanks,
--
John Hubbard
NVIDIA
next prev parent reply other threads:[~2021-08-09 6:46 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-08 23:50 [PATCH 0/3] A few gup refactorings and documentation updates John Hubbard
2021-08-08 23:50 ` [PATCH 1/3] mm/gup: documentation corrections for gup/pup John Hubbard
2021-08-09 1:39 ` Matthew Wilcox
2021-08-09 6:46 ` John Hubbard [this message]
2021-08-10 21:19 ` John Hubbard
2021-08-08 23:50 ` [PATCH 2/3] mm/gup: small refactoring: simplify try_grab_page() John Hubbard
2021-08-09 6:38 ` Christoph Hellwig
2021-08-09 6:46 ` John Hubbard
2021-08-08 23:50 ` [PATCH 3/3] mm/gup: refactor and simplify try_get_page() John Hubbard
2021-08-09 6:29 ` Christoph Hellwig
2021-08-09 6:36 ` John Hubbard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=eaaa8340-d736-e6de-cce0-7d717bee7f7a@nvidia.com \
--to=jhubbard@nvidia.com \
--cc=akpm@linux-foundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).