Commit f449bf98 authored by Shivank Garg's avatar Shivank Garg Committed by Ingo Molnar
Browse files

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: default avatarShivank Garg <shivankg@amd.com>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Acked-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
Link: https://lore.kernel.org/r/20250514062637.3287779-2-shivankg@amd.com
parent bd6afa43

arch/x86/power/hibernate.c

+5 −1
Original line number Diff line number Diff line
@@ -42,6 +42,7 @@ unsigned long relocated_restore_code __visible; 


/**

 *	pfn_is_nosave - check if given pfn is in the 'nosave' section

 *	@pfn: the page frame number to check.

 */

int pfn_is_nosave(unsigned long pfn)

{
@@ -86,7 +87,10 @@ static inline u32 compute_e820_crc32(struct e820_table *table) 
/**

 *	arch_hibernation_header_save - populate the architecture specific part

 *		of a hibernation image header

 *	@addr: address to save the data at

 *	@addr: address where architecture specific header data will be saved.

 *	@max_size: maximum size of architecture specific data in hibernation header.

 *

 *	Return: 0 on success, -EOVERFLOW if max_size is insufficient.

 */

int arch_hibernation_header_save(void *addr, unsigned int max_size)

{