From: "Oscar Alejandro Sánchez Lucero" <aleszlucero@gmail.com>
To: David Hildenbrand <david@kernel.org>,
Lorenzo Stoakes <ljs@kernel.org>,
"Liam R. Howlett" <liam@infradead.org>,
Vlastimil Babka <vbabka@kernel.org>,
Mike Rapoport <rppt@kernel.org>,
Suren Baghdasaryan <surenb@google.com>,
Michal Hocko <mhocko@suse.com>,
Andrew Morton <akpm@linux-foundation.org>
Cc: linux-mm@kvack.org, linux-kernel@vger.kernel.org,
"Oscar Alejandro Sánchez Lucero" <aleszlucero@gmail.com>
Subject: [PATCH] mm/pagewalk: document missing struct members
Date: Thu, 12 Nov 2026 18:44:07 -0600 [thread overview]
Message-ID: <20261112-pagewalk-doc-v1-1-6cc5ce7148da@gmail.com> (raw)
Add missing kernel-doc entries for @walk_lock in struct mm_walk_ops, and
for @ptep, @pudp, @pmdp, and @vma in struct folio_walk. Also fix @pte,
@pud, and @pmd descriptions to state they hold entry values, not pointers.
Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
---
include/linux/pagewalk.h | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/include/linux/pagewalk.h b/include/linux/pagewalk.h
index b41d7265c01b..978714d5e32f 100644
--- a/include/linux/pagewalk.h
+++ b/include/linux/pagewalk.h
@@ -63,6 +63,8 @@ enum page_walk_lock {
* install. If allocations fail, the walk is aborted. This
* operation is only available for userland memory. Not
* usable for hugetlb ranges.
+ * @walk_lock: locking requirement during the page walk (see
+ * enum page_walk_lock).
*
* p?d_entry callbacks are called even if those levels are folded on a
* particular architecture/configuration.
@@ -161,10 +163,14 @@ enum folio_walk_level {
* struct folio_walk - folio_walk_start() / folio_walk_end() data
* @page: exact folio page referenced (if applicable)
* @level: page table level identifying the entry type
- * @pte: pointer to the page table entry (FW_LEVEL_PTE).
- * @pmd: pointer to the page table entry (FW_LEVEL_PMD).
- * @pud: pointer to the page table entry (FW_LEVEL_PUD).
- * @ptl: pointer to the page table lock.
+ * @ptep: pointer to the page table entry (FW_LEVEL_PTE).
+ * @pudp: pointer to the page table entry (FW_LEVEL_PUD).
+ * @pmdp: pointer to the page table entry (FW_LEVEL_PMD).
+ * @pte: page table entry value (FW_LEVEL_PTE).
+ * @pud: page table entry value (FW_LEVEL_PUD).
+ * @pmd: page table entry value (FW_LEVEL_PMD).
+ * @vma: pointer to the VMA (for internal use only).
+ * @ptl: pointer to the page table lock (for internal use only).
*
* (see folio_walk_start() documentation for more details)
*/
---
base-commit: 9d66f26fefacebfeed15de31c1123451a17ff119
change-id: 20261112-pagewalk-doc-d4f0de5c03c2
Best regards,
--
Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
reply other threads:[~2026-11-13 0:44 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20261112-pagewalk-doc-v1-1-6cc5ce7148da@gmail.com \
--to=aleszlucero@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=david@kernel.org \
--cc=liam@infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=ljs@kernel.org \
--cc=mhocko@suse.com \
--cc=rppt@kernel.org \
--cc=surenb@google.com \
--cc=vbabka@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
all inboxes | Powered by JetHome®