xfs: add function name in xfs_trans_ail_delete function header comments
diff mbox series

Message ID 1567162789-137056-1-git-send-email-yukuai3@huawei.com
State New
Headers show
Series
  • xfs: add function name in xfs_trans_ail_delete function header comments
Related show

Commit Message

yu kuai Aug. 30, 2019, 10:59 a.m. UTC
Fix following warning:
make W=1 fs/xfs/xfs_trans_ail.o
fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member 
'ailp' not described in 'xfs_trans_ail_delete'
fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member
'lip' not described in 'xfs_trans_ail_delete'
fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member
'shutdown_type' not described in 'xfs_trans_ail_delete'

Since function parameters are described in the comments aready,
there is no need to add parameter comments.
Signed-off-by: yu kuai <yukuai3@huawei.com>
---
 fs/xfs/xfs_trans_ail.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Darrick J. Wong Aug. 30, 2019, 3:15 p.m. UTC | #1
On Fri, Aug 30, 2019 at 06:59:49PM +0800, yu kuai wrote:
> Fix following warning:
> make W=1 fs/xfs/xfs_trans_ail.o
> fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member 
> 'ailp' not described in 'xfs_trans_ail_delete'
> fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member
> 'lip' not described in 'xfs_trans_ail_delete'
> fs/xfs/xfs_trans_ail.c:793: warning: Function parameter or member
> 'shutdown_type' not described in 'xfs_trans_ail_delete'
> 
> Since function parameters are described in the comments aready,
> there is no need to add parameter comments.
> Signed-off-by: yu kuai <yukuai3@huawei.com>
> ---
>  fs/xfs/xfs_trans_ail.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/fs/xfs/xfs_trans_ail.c b/fs/xfs/xfs_trans_ail.c
> index 6ccfd75..b69cf59 100644
> --- a/fs/xfs/xfs_trans_ail.c
> +++ b/fs/xfs/xfs_trans_ail.c
> @@ -764,8 +764,8 @@ xfs_ail_delete_one(
>  	return mlip == lip;
>  }
>  
> -/**
> - * Remove a log items from the AIL
> +/*
> + * xfs_trans_ail_delete - remove a log items from the AIL
>   *
>   * @xfs_trans_ail_delete_bulk takes an array of log items that all need to

xfs_trans_ail_delete_bulk no longer exists.  xfs_trans_ail_delete does
not take an array of log items.  The whole comment needs to be revised
since the bulk log itme delete code was pushed into _iflush_done:

See 27af1bbf52445996 ("xfs: remove xfs_trans_ail_delete_bulk")

Erp, my bad for letting that through. :(

--D

>   * removed from the AIL. The caller is already holding the AIL lock, and done
> -- 
> 2.7.4
>

Patch
diff mbox series

diff --git a/fs/xfs/xfs_trans_ail.c b/fs/xfs/xfs_trans_ail.c
index 6ccfd75..b69cf59 100644
--- a/fs/xfs/xfs_trans_ail.c
+++ b/fs/xfs/xfs_trans_ail.c
@@ -764,8 +764,8 @@  xfs_ail_delete_one(
 	return mlip == lip;
 }
 
-/**
- * Remove a log items from the AIL
+/*
+ * xfs_trans_ail_delete - remove a log items from the AIL
  *
  * @xfs_trans_ail_delete_bulk takes an array of log items that all need to
  * removed from the AIL. The caller is already holding the AIL lock, and done