Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
Message-ID: <918fe170-51ef-e214-4620-3a82b425965c@infradead.org>
Date:   Mon, 14 Feb 2022 09:14:38 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.6.0
Subject: Re: [PATCH] block: Fix non-kernel-doc comment
Content-Language: en-US
To:     Jiapeng Chong <jiapeng.chong@linux.alibaba.com>, rafael@kernel.org
Cc:     pavel@ucw.cz, len.brown@intel.com, linux-pm@vger.kernel.org,
        linux-kernel@vger.kernel.org, Abaci Robot <abaci@linux.alibaba.com>
References: <20220214091522.100669-1-jiapeng.chong@linux.alibaba.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220214091522.100669-1-jiapeng.chong@linux.alibaba.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

Hi--

On 2/14/22 01:15, Jiapeng Chong wrote:
> Fixes the following W=1 kernel build warning:
> 
> kernel/power/swap.c:120: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst.
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>

The diff looks OK to me, but the Subject is quite misleading.
There are no "block:" patch contents here, just "PM:" or
"PM: hibernate:" according to
$ git log --oneline kernel/power/swap.c

> ---
>  kernel/power/swap.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/kernel/power/swap.c b/kernel/power/swap.c
> index 6c4f983cbacc..91fffdd2c7fb 100644
> --- a/kernel/power/swap.c
> +++ b/kernel/power/swap.c
> @@ -88,7 +88,7 @@ struct swap_map_page_list {
>  	struct swap_map_page_list *next;
>  };
>  
> -/**
> +/*
>   *	The swap_map_handle structure is used for handling swap in
>   *	a file-alike way
>   */
> @@ -116,7 +116,7 @@ struct swsusp_header {
>  
>  static struct swsusp_header *swsusp_header;
>  
> -/**
> +/*
>   *	The following functions are used for tracing the allocated
>   *	swap pages, so that they can be freed in case of an error.
>   */
> @@ -170,7 +170,7 @@ static int swsusp_extents_insert(unsigned long swap_offset)
>  	return 0;
>  }
>  
> -/**
> +/*
>   *	alloc_swapdev_block - allocate a swap page and register that it has
>   *	been allocated, so that it can be freed in case of an error.
>   */
> @@ -189,7 +189,7 @@ sector_t alloc_swapdev_block(int swap)
>  	return 0;
>  }
>  
> -/**
> +/*
>   *	free_all_swap_pages - free swap pages allocated for saving image data.
>   *	It also frees the extents used to register which swap entries had been
>   *	allocated.

thanks.
-- 
~Randy