Skip to content

Commit f449bf9

Browse files
shivankgarg98Ingo Molnar
authored andcommitted
x86/power: hibernate: Fix W=1 build kernel-doc warnings
Warnings generated with 'make W=1': arch/x86/power/hibernate.c:47: warning: Function parameter or struct member 'pfn' not described in 'pfn_is_nosave' arch/x86/power/hibernate.c:92: warning: Function parameter or struct member 'max_size' not described in 'arch_hibernation_header_save' Add missing parameter documentation in hibernate functions to fix kernel-doc warnings. Signed-off-by: Shivank Garg <shivankg@amd.com> Signed-off-by: Ingo Molnar <mingo@kernel.org> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Link: https://lore.kernel.org/r/20250514062637.3287779-2-shivankg@amd.com
1 parent bd6afa4 commit f449bf9

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

arch/x86/power/hibernate.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ unsigned long relocated_restore_code __visible;
4242

4343
/**
4444
* pfn_is_nosave - check if given pfn is in the 'nosave' section
45+
* @pfn: the page frame number to check.
4546
*/
4647
int pfn_is_nosave(unsigned long pfn)
4748
{
@@ -86,7 +87,10 @@ static inline u32 compute_e820_crc32(struct e820_table *table)
8687
/**
8788
* arch_hibernation_header_save - populate the architecture specific part
8889
* of a hibernation image header
89-
* @addr: address to save the data at
90+
* @addr: address where architecture specific header data will be saved.
91+
* @max_size: maximum size of architecture specific data in hibernation header.
92+
*
93+
* Return: 0 on success, -EOVERFLOW if max_size is insufficient.
9094
*/
9195
int arch_hibernation_header_save(void *addr, unsigned int max_size)
9296
{

0 commit comments

Comments
 (0)