From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>,
linux-mm@kvack.org, Mike Rapoport <rppt@kernel.org>,
linux-doc@vger.kernel.org, cgroups@vger.kernel.org
Subject: [PATCH 2/4] mm: Fix get_mctgt_type() kernel-doc
Date: Fri, 18 Aug 2023 21:06:28 +0100 [thread overview]
Message-ID: <20230818200630.2719595-3-willy@infradead.org> (raw)
In-Reply-To: <20230818200630.2719595-1-willy@infradead.org>
Convert the return values to an ReST list and tidy up the wording while
I'm touching it.
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
mm/memcontrol.c | 31 +++++++++++++------------------
1 file changed, 13 insertions(+), 18 deletions(-)
diff --git a/mm/memcontrol.c b/mm/memcontrol.c
index e041ba827e59..cd8b3ae6b8d9 100644
--- a/mm/memcontrol.c
+++ b/mm/memcontrol.c
@@ -5850,25 +5850,20 @@ static int mem_cgroup_move_account(struct page *page,
* @ptent: the pte to be checked
* @target: the pointer the target page or swap ent will be stored(can be NULL)
*
- * Returns
- * 0(MC_TARGET_NONE): if the pte is not a target for move charge.
- * 1(MC_TARGET_PAGE): if the page corresponding to this pte is a target for
- * move charge. if @target is not NULL, the page is stored in target->page
- * with extra refcnt got(Callers should handle it).
- * 2(MC_TARGET_SWAP): if the swap entry corresponding to this pte is a
- * target for charge migration. if @target is not NULL, the entry is stored
- * in target->ent.
- * 3(MC_TARGET_DEVICE): like MC_TARGET_PAGE but page is device memory and
- * thus not on the lru.
- * For now we such page is charge like a regular page would be as for all
- * intent and purposes it is just special memory taking the place of a
- * regular page.
- *
- * See Documentations/vm/hmm.txt and include/linux/hmm.h
- *
- * Called with pte lock held.
+ * Context: Called with pte lock held.
+ * Return:
+ * * MC_TARGET_NONE - If the pte is not a target for move charge.
+ * * MC_TARGET_PAGE - If the page corresponding to this pte is a target for
+ * move charge. If @target is not NULL, the page is stored in target->page
+ * with extra refcnt got (Callers should handle it).
+ * * MC_TARGET_SWAP - If the swap entry corresponding to this pte is a
+ * target for charge migration. if @target is not NULL, the entry is stored
+ * in target->ent.
+ * * MC_TARGET_DEVICE - Like MC_TARGET_PAGE but page is device memory and
+ * thus not on the lru. For now such page is charged like a regular page
+ * would be as it is just special memory taking the place of a regular page.
+ * See Documentations/vm/hmm.txt and include/linux/hmm.h
*/
-
static enum mc_target_type get_mctgt_type(struct vm_area_struct *vma,
unsigned long addr, pte_t ptent, union mc_target *target)
{
--
2.40.1
next prev parent reply other threads:[~2023-08-18 20:06 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-18 20:06 [PATCH 0/4] Improve mm documentation Matthew Wilcox (Oracle)
2023-08-18 20:06 ` [PATCH 1/4] mm: Fix kernel-doc warning from tlb_flush_rmaps() Matthew Wilcox (Oracle)
2023-08-20 0:51 ` Randy Dunlap
2023-08-21 14:51 ` Mike Rapoport
2023-08-18 20:06 ` Matthew Wilcox (Oracle) [this message]
2023-08-20 0:52 ` [PATCH 2/4] mm: Fix get_mctgt_type() kernel-doc Randy Dunlap
2023-08-21 14:53 ` Mike Rapoport
2023-08-18 20:06 ` [PATCH 3/4] mm: Fix clean_record_shared_mapping_range kernel-doc Matthew Wilcox (Oracle)
2023-08-20 0:51 ` Randy Dunlap
2023-08-21 14:54 ` Mike Rapoport
2023-08-18 20:06 ` [PATCH 4/4] mm: Add orphaned kernel-doc to the rst files Matthew Wilcox (Oracle)
2023-08-21 14:55 ` Mike Rapoport
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=20230818200630.2719595-3-willy@infradead.org \
--to=willy@infradead.org \
--cc=akpm@linux-foundation.org \
--cc=cgroups@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=rppt@kernel.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