linux-kernel - [PATCH -next] mm/treewide: Add missing kernel-doc function comments.

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 for Android: free password hash cracker in your pocket

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

Date: Fri, 28 Jun 2024 17:14:56 +0800
From: Yang Li <yang.lee@...ux.alibaba.com>
To: mingo@...hat.com
Cc: rafael@...nel.org,
	tglx@...utronix.de,
	pavel@....cz,
	linux-pm@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Yang Li <yang.lee@...ux.alibaba.com>,
	Abaci Robot <abaci@...ux.alibaba.com>
Subject: [PATCH -next] mm/treewide: Add missing kernel-doc function comments.

Add kernel-doc style comments for the pfn_is_nosave and
arch_hibernation_header_save functions.

Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9453
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 arch/x86/power/hibernate.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/arch/x86/power/hibernate.c b/arch/x86/power/hibernate.c
index 5b81d19cd114..90f682ff63b1 100644
--- a/arch/x86/power/hibernate.c
+++ b/arch/x86/power/hibernate.c
@@ -41,7 +41,8 @@ unsigned long temp_pgt __visible;
 unsigned long relocated_restore_code __visible;
 
 /**
- *	pfn_is_nosave - check if given pfn is in the 'nosave' section
+ * 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)
 {
@@ -84,9 +85,11 @@ static inline u32 compute_e820_crc32(struct e820_table *table)
 #endif
 
 /**
- *	arch_hibernation_header_save - populate the architecture specific part
- *		of a hibernation image header
- *	@addr: address to save the data at
+ * arch_hibernation_header_save - populate the architecture specific part
+ * of a hibernation image header
+ * @addr: address to save the data at
+ * @max_size: the maximum size of the data to save
+ *
  */
 int arch_hibernation_header_save(void *addr, unsigned int max_size)
 {
-- 
2.20.1.7.g153144c