* + mm-workingset-correct-kernel-doc-notations.patch added to -mm tree
@ 2021-08-09 19:14 akpm
0 siblings, 0 replies; only message in thread
From: akpm @ 2021-08-09 19:14 UTC (permalink / raw)
To: mm-commits, willy, rdunlap
The patch titled
Subject: mm/workingset: correct kernel-doc notations
has been added to the -mm tree. Its filename is
mm-workingset-correct-kernel-doc-notations.patch
This patch should soon appear at
https://ozlabs.org/~akpm/mmots/broken-out/mm-workingset-correct-kernel-doc-notations.patch
and later at
https://ozlabs.org/~akpm/mmotm/broken-out/mm-workingset-correct-kernel-doc-notations.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: Randy Dunlap <rdunlap@infradead.org>
Subject: mm/workingset: correct kernel-doc notations
Use the documented kernel-doc format to prevent kernel-doc warnings.
mm/workingset.c:256: warning: No description found for return value of 'workingset_eviction'
mm/workingset.c:285: warning: Function parameter or member 'folio' not described in 'workingset_refault'
mm/workingset.c:285: warning: Excess function parameter 'page' description in 'workingset_refault'
Link: https://lkml.kernel.org/r/20210808203153.10678-1-rdunlap@infradead.org
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---
mm/workingset.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- a/mm/workingset.c~mm-workingset-correct-kernel-doc-notations
+++ a/mm/workingset.c
@@ -249,7 +249,7 @@ void workingset_age_nonresident(struct l
* @target_memcg: the cgroup that is causing the reclaim
* @page: the page being evicted
*
- * Returns a shadow entry to be stored in @page->mapping->i_pages in place
+ * Return: a shadow entry to be stored in @page->mapping->i_pages in place
* of the evicted @page so that a later refault can be detected.
*/
void *workingset_eviction(struct page *page, struct mem_cgroup *target_memcg)
@@ -274,7 +274,7 @@ void *workingset_eviction(struct page *p
/**
* workingset_refault - evaluate the refault of a previously evicted folio
- * @page: the freshly allocated replacement folio
+ * @folio: the freshly allocated replacement folio
* @shadow: shadow entry of the evicted folio
*
* Calculates and evaluates the refault distance of the previously
_
Patches currently in -mm which might be from rdunlap@infradead.org are
alpha-agp-make-empty-macros-use-do-while-0-style.patch
lib-dump_stack-correct-kernel-doc-notation.patch
lib-iov_iterc-fix-kernel-doc-warnings.patch
fs-epoll-use-a-per-cpu-counter-for-users-watches-count-fix.patch
mm-workingset-correct-kernel-doc-notations.patch
scripts-check_extable-fix-typo-in-user-error-message.patch
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2021-08-09 19:14 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-09 19:14 + mm-workingset-correct-kernel-doc-notations.patch added to -mm tree akpm
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).