linux-kernel - [tip: x86/cleanups] x86/power: hibernate: Fix W=1 build kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <174721002142.406.2035568473511213094.tip-bot2@tip-bot2>
Date: Wed, 14 May 2025 08:07:01 -0000
From: "tip-bot2 for Shivank Garg" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Shivank Garg <shivankg@....com>, Ingo Molnar <mingo@...nel.org>,
 "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>, x86@...nel.org,
 linux-kernel@...r.kernel.org
Subject:
 [tip: x86/cleanups] x86/power: hibernate: Fix W=1 build kernel-doc warnings

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     f449bf98b7b63702e86155fe5fa3c853c3bf1fda
Gitweb:        https://git.kernel.org/tip/f449bf98b7b63702e86155fe5fa3c853c3bf1fda
Author:        Shivank Garg <shivankg@....com>
AuthorDate:    Wed, 14 May 2025 06:26:38 
Committer:     Ingo Molnar <mingo@...nel.org>
CommitterDate: Wed, 14 May 2025 09:58:54 +02:00

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@....com>
Signed-off-by: Ingo Molnar <mingo@...nel.org>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@...el.com>
Link: https://lore.kernel.org/r/20250514062637.3287779-2-shivankg@amd.com
---
 arch/x86/power/hibernate.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/arch/x86/power/hibernate.c b/arch/x86/power/hibernate.c
index 5b81d19..a7c23f2 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)
 {