From: Adi Nata <adinata.softwareengineer@gmail.com>
To: rafael@kernel.org
Cc: linux-kernel-mentees@lists.linux.dev,
Adi Nata <adinata.softwareengineer@gmail.com>,
Pavel Machek <pavel@kernel.org>, Len Brown <lenb@kernel.org>,
linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] PM: hibernate: Fix kernel-doc comment for add_rtree_block()
Date: Sun, 7 Jun 2026 19:05:55 +0800 [thread overview]
Message-ID: <20260607110555.53248-1-adinata.softwareengineer@gmail.com> (raw)
The kernel-doc comment for add_rtree_block() was missing @param
descriptions for all four of its parameters (zone, gfp_mask,
safe_needed, ca), causing build-time warnings (make W=1)
kernel/power/snapshot.c:469: warning: Function parameter or
member 'zone' not described in 'add_rtree_block'
kernel/power/snapshot.c:469: warning: Function parameter or
member 'gfp_mask' not described in 'add_rtree_block'
kernel/power/snapshot.c:469: warning: Function parameter or
member 'safe_needed' not described in 'add_rtree_block'
kernel/power/snapshot.c:469: warning: Function parameter or
member 'ca' not described in 'add_rtree_block'
Add the missing @param tags, reusing the wording from the
neighbouring alloc_rtree_node() for the shared parameters.
Signed-off-by: Adi Nata <adinata.softwareengineer@gmail.com>
---
kernel/power/snapshot.c | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
index a564650734dc..cd582be86412 100644
--- a/kernel/power/snapshot.c
+++ b/kernel/power/snapshot.c
@@ -459,9 +459,13 @@ static struct rtree_node *alloc_rtree_node(gfp_t gfp_mask, int safe_needed,
}
/**
- * add_rtree_block - Add a new leave node to the radix tree.
+ * add_rtree_block - Add a new leaf node to the radix tree of a memory zone.
+ * @zone: The memory zone's radix tree bitmap to extend with a new leaf block.
+ * @gfp_mask: GFP mask for the allocation.
+ * @safe_needed: Get pages not used before hibernation (restore only)
+ * @ca: Pointer to a linked list of pages ("a chain") to allocate from
*
- * The leave nodes need to be allocated in order to keep the leaves
+ * The leaf nodes need to be allocated in order to keep the leaves
* linked list in order. This is guaranteed by the zone->blocks
* counter.
*/
--
2.47.3
reply other threads:[~2026-06-07 11:06 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=20260607110555.53248-1-adinata.softwareengineer@gmail.com \
--to=adinata.softwareengineer@gmail.com \
--cc=lenb@kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=pavel@kernel.org \
--cc=rafael@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