Skip to contentSkip to conversation

PM: hibernate: Fix kernel-doc comment for add_rtree_block()

PATCH In review Adi Nata 2 participants 2 messages Jun 7 – Jun 8

Subsystems (2)
Suspend to RAM Hibernation
lore
Share & tools
lore

Adi Nata

author
#0 lore raw

PATCH 1/1 PM: hibernate: Fix kernel-doc comment for add_rtree_block()

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 <[email protected]>
---
 kernel/power/snapshot.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
kernel/power/snapshot.c +6 -2
index a564650734dc..cd582be86412 100644
@@ -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.
  */
Signature · 1 line
2.47.3
maintainer
#1 lore raw
Quoted 14 lines · Adi Nata

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'

Quoted 4 lines

Add the missing @param tags, reusing the wording from the neighbouring alloc_rtree_node() for the shared parameters.

Signed-off-by Adi Nata <[email protected]>

It's a static function that doesn't require a kerneldoc comment.

If you just want the warning to go away, replace the kerneldoc comment marker /** with a regular comment marker /* in that comment.

Thanks!

Quoted 28 lines
---
 kernel/power/snapshot.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
kernel/power/snapshot.c +6 -3
index a564650734dc..cd582be86412 100644
@@ -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