Skip to content

Commit 467df4c

Browse files
Yang Lirafaeljw
authored andcommitted
PM: hibernate: Fix some kernel-doc comments
Add parameter description in alloc_rtree_node() kernel-doc comment and fix several inconsistent function name descriptions. Remove some warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. kernel/power/snapshot.c:438: warning: Function parameter or member 'gfp_mask' not described in 'alloc_rtree_node' kernel/power/snapshot.c:438: warning: Function parameter or member 'safe_needed' not described in 'alloc_rtree_node' kernel/power/snapshot.c:438: warning: Function parameter or member 'ca' not described in 'alloc_rtree_node' kernel/power/snapshot.c:438: warning: Function parameter or member 'list' not described in 'alloc_rtree_node' kernel/power/snapshot.c:916: warning: expecting prototype for memory_bm_rtree_next_pfn(). Prototype was for memory_bm_next_pfn() instead kernel/power/snapshot.c:1947: warning: expecting prototype for alloc_highmem_image_pages(). Prototype was for alloc_highmem_pages() instead kernel/power/snapshot.c:2230: warning: expecting prototype for load header(). Prototype was for load_header() instead Reported-by: Abaci Robot <abaci@linux.alibaba.com> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> [ rjw: Comment adjustments to avoid line breaks ] Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
1 parent ce1cb68 commit 467df4c

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

kernel/power/snapshot.c

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,10 @@ struct memory_bitmap {
427427

428428
/**
429429
* alloc_rtree_node - Allocate a new node and add it to the radix tree.
430+
* @gfp_mask: GFP mask for the allocation.
431+
* @safe_needed: Get pages not used before hibernation (restore only)
432+
* @ca: Pointer to a linked list of pages ("a chain") to allocate from
433+
* @list: Radix Tree node to add.
430434
*
431435
* This function is used to allocate inner nodes as well as the
432436
* leave nodes of the radix tree. It also adds the node to the
@@ -902,7 +906,7 @@ static bool rtree_next_node(struct memory_bitmap *bm)
902906
}
903907

904908
/**
905-
* memory_bm_rtree_next_pfn - Find the next set bit in a memory bitmap.
909+
* memory_bm_next_pfn - Find the next set bit in a memory bitmap.
906910
* @bm: Memory bitmap.
907911
*
908912
* Starting from the last returned position this function searches for the next
@@ -1937,7 +1941,7 @@ static inline int get_highmem_buffer(int safe_needed)
19371941
}
19381942

19391943
/**
1940-
* alloc_highmem_image_pages - Allocate some highmem pages for the image.
1944+
* alloc_highmem_pages - Allocate some highmem pages for the image.
19411945
*
19421946
* Try to allocate as many pages as needed, but if the number of free highmem
19431947
* pages is less than that, allocate them all.
@@ -2224,7 +2228,7 @@ static int check_header(struct swsusp_info *info)
22242228
}
22252229

22262230
/**
2227-
* load header - Check the image header and copy the data from it.
2231+
* load_header - Check the image header and copy the data from it.
22282232
*/
22292233
static int load_header(struct swsusp_info *info)
22302234
{

0 commit comments

Comments
 (0)