diff options
| author | Shivank Garg <shivankg@amd.com> | 2025-05-14 06:26:38 +0000 |
|---|---|---|
| committer | Ingo Molnar <mingo@kernel.org> | 2025-05-14 09:58:54 +0200 |
| commit | f449bf98b7b63702e86155fe5fa3c853c3bf1fda (patch) | |
| tree | 9f3cf760b836c9897d30859a145dff8a0f075234 | |
| parent | bd6afa43eee175ba146f6f9a27d6d24eeaab0a45 (diff) | |
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
| -rw-r--r-- | arch/x86/power/hibernate.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/arch/x86/power/hibernate.c b/arch/x86/power/hibernate.c index 5b81d19cd114..a7c23f2a58c9 100644 --- a/arch/x86/power/hibernate.c +++ b/arch/x86/power/hibernate.c @@ -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) { |