History

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

Yang Li committed 4 years ago

Commit 467df4c1 parent ce1cb681 file · +7 −3Browse files

Showing the changes to kernel/power (1 of 1 file). Show all

Unified · Split

kernel/power/snapshot.c+7−3
@@ -427,6 +427,10 @@ struct memory_bitmap { · 426 unmodified lines
427 427
428/**428/**
429 * alloc_rtree_node - Allocate a new node and add it to the radix tree.429 * 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.
430 *434 *
431 * This function is used to allocate inner nodes as well as the435 * This function is used to allocate inner nodes as well as the
432 * leave nodes of the radix tree. It also adds the node to the436 * 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) · 469 unmodified lines
902}906}
903 907
904/**908/**
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.
906 * @bm: Memory bitmap.910 * @bm: Memory bitmap.
907 *911 *
908 * Starting from the last returned position this function searches for the next912 * 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) · 1028 unmodified lines
1937}1941}
1938 1942
1939/**1943/**
1940 * alloc_highmem_image_pages - Allocate some highmem pages for the image.1944 * alloc_highmem_pages - Allocate some highmem pages for the image.
1941 *1945 *
1942 * Try to allocate as many pages as needed, but if the number of free highmem1946 * Try to allocate as many pages as needed, but if the number of free highmem
1943 * pages is less than that, allocate them all.1947 * pages is less than that, allocate them all.
@@ -2224,7 +2228,7 @@ static int check_header(struct swsusp_info *info) · 280 unmodified lines
2224}2228}
2225 2229
2226/**2230/**
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.
2228 */2232 */
2229static int load_header(struct swsusp_info *info)2233static int load_header(struct swsusp_info *info)
2230{2234{