linux-kernel - Re: Fwd: [PATCH] fs: direct-io: Fixed a Documentation build warn

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>] [day] [month] [year] [list]

Message-ID: <c811c429-3ad5-8601-318a-850a26a46531@linuxfoundation.org>
Date:   Mon, 23 Sep 2019 15:59:55 -0600
From:   Shuah Khan <skhan@...uxfoundation.org>
To:     Madhuparna Bhowmik <madhuparnabhowmik04@...il.com>,
        linux-kernel-mentees@...ts.linuxfoundation.org
Cc:     linux-kernel@...r.kernel.org, linux-fsdevel@...r.kernel.org,
        "skh >> Shuah Khan" <skhan@...uxfoundation.org>
Subject: Re: Fwd: [PATCH] fs: direct-io: Fixed a Documentation build warn

On 9/23/19 3:03 PM, Madhuparna Bhowmik wrote:
> Fixed Excess function parameters warning.
> warning: Excess function parameter 'offset' description in
> 'dio_complete'.
> Removed the description of the local variable offset from the
> description for arguments of a function and added it with the
> declaration of the variable.

Change the commit log to say: Fixes instead of Fixed and Removes
instead of Removed.

Also I think what you mean to say is that the this patch removes
offset which isn't an argument to the function from the function
header. Can you rephrase the commit log.

> 
> Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@...il.com 
> <mailto:madhuparnabhowmik04@...il.com>>

Why is this a Fwd::

> ---
>   fs/direct-io.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/direct-io.c b/fs/direct-io.c
> index ae196784f487..a9cb770f0bc1 100644
> --- a/fs/direct-io.c
> +++ b/fs/direct-io.c
> @@ -243,7 +243,6 @@ void dio_warn_stale_pagecache(struct file *filp)
> 
>   /**
>    * dio_complete() - called when all DIO BIO I/O has been completed
> - * @offset: the byte offset in the file of the completed operation
>    *
>    * This drops i_dio_count, lets interested parties know that a DIO 
> operation
>    * has completed, and calculates the resulting return code for the 
> operation.
> @@ -255,6 +254,7 @@ void dio_warn_stale_pagecache(struct file *filp)
>    */
>   static ssize_t dio_complete(struct dio *dio, ssize_t ret, unsigned int 
> flags)
>   {
> +       /* offset: the byte offset in the file of the completed operation */
>          loff_t offset = dio->iocb->ki_pos;
>          ssize_t transferred = 0;
>          int err;
> -- 
> 2.17.1
> 
> ᐧ
> ᐧ

thanks,
-- Shuah