linux-kernel - Re: [PATCH 2/4] 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] [day] [month] [year] [list]

Message-ID: <CAJZ5v0gm2WvcxeAHf5_Ct2RyK+fjoDz1Ck+T7DjpnBefJcPqFQ@mail.gmail.com>
Date: Wed, 30 Apr 2025 16:16:43 +0200
From: "Rafael J. Wysocki" <rafael@...nel.org>
To: Shivank Garg <shivankg@....com>
Cc: mingo@...hat.com, bp@...en8.de, dave.hansen@...ux.intel.com, 
	x86@...nel.org, hpa@...or.com, luto@...nel.org, peterz@...radead.org, 
	rafael@...nel.org, pavel@...nel.org, akpm@...ux-foundation.org, 
	linux-kernel@...r.kernel.org, linux-pm@...r.kernel.org
Subject: Re: [PATCH 2/4] x86/power: hibernate: Fix W=1 build kernel-doc warnings

On Wed, Apr 30, 2025 at 1:31 PM Shivank Garg <shivankg@....com> wrote:
>
> 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@....com>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@...el.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
>