From: Shivank Garg <shivankg@amd.com>
To: <tglx@linutronix.d>, <mingo@redhat.com>, <bp@alien8.de>,
<dave.hansen@linux.intel.com>, <x86@kernel.org>, <hpa@zytor.com>,
<luto@kernel.org>, <peterz@infradead.org>, <rafael@kernel.org>,
<pavel@kernel.org>, <akpm@linux-foundation.org>
Cc: <linux-kernel@vger.kernel.org>, <linux-pm@vger.kernel.org>,
<shivankg@amd.com>
Subject: [PATCH 2/4] x86/power: hibernate: Fix W=1 build kernel-doc warnings
Date: Wed, 30 Apr 2025 11:30:00 +0000 [thread overview]
Message-ID: <20250430113001.546066-2-shivankg@amd.com> (raw)
In-Reply-To: <20250430113001.546066-1-shivankg@amd.com>
Sample 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>
---
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 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)
{
--
2.34.1
next prev parent reply other threads:[~2025-04-30 11:31 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-30 11:29 [PATCH 1/4] x86/mm: pgtable: Fix W=1 build kernel-doc warnings Shivank Garg
2025-04-30 11:30 ` Shivank Garg [this message]
2025-04-30 14:16 ` [PATCH 2/4] x86/power: hibernate: " Rafael J. Wysocki
2025-04-30 11:30 ` [PATCH 3/4] x86/mm/pat: Fix W=1 build kernel-doc warning Shivank Garg
2025-04-30 11:30 ` [PATCH 4/4] x86/apic: " Shivank Garg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250430113001.546066-2-shivankg@amd.com \
--to=shivankg@amd.com \
--cc=akpm@linux-foundation.org \
--cc=bp@alien8.de \
--cc=dave.hansen@linux.intel.com \
--cc=hpa@zytor.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=luto@kernel.org \
--cc=mingo@redhat.com \
--cc=pavel@kernel.org \
--cc=peterz@infradead.org \
--cc=rafael@kernel.org \
--cc=tglx@linutronix.d \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox