Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <a063c19e-f6b9-a7ae-a199-1fc60de01c21@infradead.org>
Date:   Tue, 16 Aug 2022 15:47:45 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments
Content-Language: en-US
To:     Yang Li <yang.lee@linux.alibaba.com>, viro@zeniv.linux.org.uk
Cc:     linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org,
        Abaci Robot <abaci@linux.alibaba.com>
References: <20220815054411.68818-1-yang.lee@linux.alibaba.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220815054411.68818-1-yang.lee@linux.alibaba.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 8/14/22 22:44, Yang Li wrote:
> Add a colon between the parameter name and description to meet the
> scripts/kernel-doc.
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=1901
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  fs/kernel_read_file.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/fs/kernel_read_file.c b/fs/kernel_read_file.c
> index 5d826274570c..c4fc84e6d099 100644
> --- a/fs/kernel_read_file.c
> +++ b/fs/kernel_read_file.c
> @@ -8,16 +8,16 @@
>  /**
>   * kernel_read_file() - read file contents into a kernel buffer
>   *
> - * @file	file to read from
> - * @offset	where to start reading from (see below).
> - * @buf		pointer to a "void *" buffer for reading into (if
> + * @file:	file to read from
> + * @offset:	where to start reading from (see below).
> + * @buf:	pointer to a "void *" buffer for reading into (if
>   *		*@buf is NULL, a buffer will be allocated, and
>   *		@buf_size will be ignored)
> - * @buf_size	size of buf, if already allocated. If @buf not
> + * @buf_size:	size of buf, if already allocated. If @buf not
>   *		allocated, this is the largest size to allocate.
> - * @file_size	if non-NULL, the full size of @file will be
> + * @file_size:	if non-NULL, the full size of @file will be
>   *		written here.
> - * @id		the kernel_read_file_id identifying the type of
> + * @id:	the kernel_read_file_id identifying the type of
>   *		file contents being read (for LSMs to examine)
>   *
>   * @offset must be 0 unless both @buf and @file_size are non-NULL

-- 
~Randy