[PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers

From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Bob Peterson <rpeterso@redhat.com>,
	Andreas Gruenbacher <agruenba@redhat.com>,
	cluster-devel@redhat.com
Subject: [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers
Date: Tue, 30 Mar 2021 17:44:32 +0100	[thread overview]
Message-ID: <20210330164458.1625478-6-lee.jones@linaro.org> (raw)
In-Reply-To: <20210330164458.1625478-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 fs/gfs2/log.c:76: warning: Excess function parameter 'mapping' description in 'gfs2_remove_from_ail'
 fs/gfs2/log.c:97: warning: Function parameter or member 'tr' not described in 'gfs2_ail1_start_one'
 fs/gfs2/log.c:97: warning: Function parameter or member 'plug' not described in 'gfs2_ail1_start_one'
 fs/gfs2/log.c:97: warning: Excess function parameter 'ai' description in 'gfs2_ail1_start_one'
 fs/gfs2/log.c:278: warning: Function parameter or member 'sdp' not described in 'gfs2_ail_empty_tr'
 fs/gfs2/log.c:278: warning: Function parameter or member 'tr' not described in 'gfs2_ail_empty_tr'
 fs/gfs2/log.c:278: warning: Function parameter or member 'head' not described in 'gfs2_ail_empty_tr'
 fs/gfs2/log.c:1174: warning: Function parameter or member 'sdp' not described in 'gfs2_merge_trans'
 fs/gfs2/log.c:1174: warning: Excess function parameter 'old' description in 'gfs2_merge_trans'
 fs/gfs2/log.c:1293: warning: Function parameter or member 'data' not described in 'gfs2_logd'
 fs/gfs2/log.c:1293: warning: Excess function parameter 'sdp' description in 'gfs2_logd'

Cc: Bob Peterson <rpeterso@redhat.com>
Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: cluster-devel@redhat.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 fs/gfs2/log.c | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/fs/gfs2/log.c b/fs/gfs2/log.c
index 6410281546f92..eef33cd251e4b 100644
--- a/fs/gfs2/log.c
+++ b/fs/gfs2/log.c
@@ -65,7 +65,6 @@ unsigned int gfs2_struct2blk(struct gfs2_sbd *sdp, unsigned int nstruct)
 
 /**
  * gfs2_remove_from_ail - Remove an entry from the ail lists, updating counters
- * @mapping: The associated mapping (maybe NULL)
  * @bd: The gfs2_bufdata to remove
  *
  * The ail lock _must_ be held when calling this function
@@ -81,12 +80,10 @@ void gfs2_remove_from_ail(struct gfs2_bufdata *bd)
 	brelse(bd->bd_bh);
 }
 
-/**
+/*
  * gfs2_ail1_start_one - Start I/O on a part of the AIL
  * @sdp: the filesystem
  * @wbc: The writeback control structure
- * @ai: The ail structure
- *
  */
 
 static int gfs2_ail1_start_one(struct gfs2_sbd *sdp,
@@ -269,7 +266,7 @@ static void gfs2_log_update_head(struct gfs2_sbd *sdp)
 	sdp->sd_log_head = new_head;
 }
 
-/**
+/*
  * gfs2_ail_empty_tr - empty one of the ail lists of a transaction
  */
 
@@ -1166,7 +1163,7 @@ void gfs2_log_flush(struct gfs2_sbd *sdp, struct gfs2_glock *gl, u32 flags)
 
 /**
  * gfs2_merge_trans - Merge a new transaction into a cached transaction
- * @old: Original transaction to be expanded
+ * @sdp: the filesystem
  * @new: New transaction to be merged
  */
 
@@ -1283,7 +1280,7 @@ static inline int gfs2_ail_flush_reqd(struct gfs2_sbd *sdp)
 
 /**
  * gfs2_logd - Update log tail as Active Items get flushed to in-place blocks
- * @sdp: Pointer to GFS2 superblock
+ * @data: Pointer to GFS2 superblock
  *
  * Also, periodically check to make sure that we're using the most recent
  * journal index.
-- 
2.27.0

