cluster-devel.redhat.com archive mirror
 help / color / mirror / Atom feed
* [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS
@ 2021-03-30 16:44 Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others Lee Jones
                   ` (18 more replies)
  0 siblings, 19 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.

There is more to do in filesystems.  Another set will follow.

Lee Jones (31):
  fs: gfs2: dir: Finish off mostly complete headers demote others
  fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant
    ones
  fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others
  fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote
    others
  fs: gfs2: log: Fix a couple of param descriptions and demote
    non-conformant headers
  fs: gfs2: lops: Help out worthy kernel-doc headers and demote others
  fs: gfs2: glock: Fix some deficient kernel-doc headers and demote
    non-conformant ones
  fs: gfs2: aops: Fix a little potential doc-rot
  fs: gfs2: meta_io: Add missing description for 'rahead' param
  fs: gfs2: inode: Fix worthy function headers demote others
  fs: gfs2: file: Strip out superfluous param description and demote
    kernel-doc abuse
  fs: gfs2: ops_fstype: Fix a little doc-rot
  fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad'
  fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours
  fs: gfs2: recovery: Provide missing param descriptions and remove one
    other
  fs: gfs2: super: Fix kernel-doc issues where feasible demote one other
  fs: gfs2: util: Fix one conformant kernel-doc header and demote a
    bunch of abuses
  fs: gfs2: lock_dlm: Demote incomplete kernel-doc header
  fs: ecryptfs: read_write: File headers do not make good candidates for
    kernel-doc
  fs: ecryptfs: debug: Demote a couple of kernel-doc abuses
  fs: ecryptfs: dentry: File headers are not good candidates for
    kernel-doc
  fs: ecryptfs: kthread: Demote file header and provide description for
    'cred'
  fs: ecryptfs: file: Demote kernel-doc abuses
  fs: ecryptfs: super: Fix formatting, naming and kernel-doc abuses
  fs: ecryptfs: messaging: Add missing param descriptions and demote
    abuses
  fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc
    headers
  fs: ecryptfs: miscdev: File headers are not good kernel-doc candidates
  fs: ecryptfs: crypto: Supply some missing param descriptions and
    demote abuses
  fs: ecryptfs: mmap: Help out one function header and demote other
    abuses
  fs: ecryptfs: inode: Help out nearly-there header and demote
    non-conformant ones
  fs: ecryptfs: keystore: Fix some kernel-doc issues and demote
    non-conformant headers

 fs/ecryptfs/crypto.c     | 20 ++++++++++----------
 fs/ecryptfs/debug.c      |  4 ++--
 fs/ecryptfs/dentry.c     |  2 +-
 fs/ecryptfs/file.c       |  4 ++--
 fs/ecryptfs/inode.c      | 11 +++++------
 fs/ecryptfs/keystore.c   | 13 +++++++------
 fs/ecryptfs/kthread.c    |  3 ++-
 fs/ecryptfs/main.c       | 20 +++++++++-----------
 fs/ecryptfs/messaging.c  |  8 +++++---
 fs/ecryptfs/miscdev.c    |  3 ++-
 fs/ecryptfs/mmap.c       | 11 ++++++-----
 fs/ecryptfs/read_write.c |  4 +++-
 fs/ecryptfs/super.c      |  8 ++++----
 fs/gfs2/aops.c           |  5 +----
 fs/gfs2/bmap.c           |  4 ++--
 fs/gfs2/dir.c            | 35 +++++++++++++----------------------
 fs/gfs2/file.c           |  3 +--
 fs/gfs2/glock.c          |  9 ++++-----
 fs/gfs2/glops.c          | 18 ++++++------------
 fs/gfs2/inode.c          | 22 ++++++++++++----------
 fs/gfs2/lock_dlm.c       |  3 +--
 fs/gfs2/log.c            | 11 ++++-------
 fs/gfs2/lops.c           | 13 +++++++------
 fs/gfs2/meta_io.c        |  1 +
 fs/gfs2/ops_fstype.c     |  7 ++-----
 fs/gfs2/quota.c          |  2 +-
 fs/gfs2/recovery.c       |  3 ++-
 fs/gfs2/rgrp.c           |  4 +++-
 fs/gfs2/super.c          | 13 ++++++-------
 fs/gfs2/util.c           | 19 ++++++++++---------
 fs/gfs2/xattr.c          | 25 +++++++------------------
 31 files changed, 141 insertions(+), 167 deletions(-)

Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Bob Peterson <rpeterso@redhat.com>
Cc: Christian Brauner <christian.brauner@ubuntu.com>
Cc: cluster-devel at redhat.com
Cc: David Howells <dhowells@redhat.com>
Cc: ecryptfs at vger.kernel.org
Cc: Eric Biggers <ebiggers@google.com>
Cc: James Morris <jamorris@linux.microsoft.com>
Cc: Johannes Weiner <hannes@cmpxchg.org>
Cc: "Michael A. Halcrow" <mahalcro@us.ibm.com>
Cc: "Michael A. Halcrow" <mhalcrow@us.ibm.com>
Cc: "Michael C. Thompsion" <mcthomps@us.ibm.com>
Cc: "Michael C. Thompson" <mcthomps@us.ibm.com>
Cc: Michal Hocko <mhocko@suse.com>
Cc: "Trevor S. Highland" <trevor.highland@gmail.com>
Cc: Tycho Andersen <tycho@tycho.pizza>
Cc: Tyler Hicks <code@tyhicks.com>
Cc: Waiman Long <longman@redhat.com>
-- 
2.27.0



^ permalink raw reply	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 02/31] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones Lee Jones
                   ` (17 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/dir.c:781: warning: Function parameter or member 'index' not described in 'get_leaf_nr'
 fs/gfs2/dir.c:907: warning: Function parameter or member 'inode' not described in 'dir_make_exhash'
 fs/gfs2/dir.c:907: warning: Excess function parameter 'dip' description in 'dir_make_exhash'
 fs/gfs2/dir.c:1002: warning: Function parameter or member 'inode' not described in 'dir_split_leaf'
 fs/gfs2/dir.c:1002: warning: Function parameter or member 'name' not described in 'dir_split_leaf'
 fs/gfs2/dir.c:1002: warning: Excess function parameter 'dip' description in 'dir_split_leaf'
 fs/gfs2/dir.c:1002: warning: Excess function parameter 'leaf_no' description in 'dir_split_leaf'
 fs/gfs2/dir.c:1268: warning: Function parameter or member 'sort_start' not described in 'do_filldir_main'
 fs/gfs2/dir.c:1479: warning: Function parameter or member 'inode' not described in 'gfs2_dir_readahead'
 fs/gfs2/dir.c:1479: warning: Function parameter or member 'hsize' not described in 'gfs2_dir_readahead'
 fs/gfs2/dir.c:1479: warning: Function parameter or member 'index' not described in 'gfs2_dir_readahead'
 fs/gfs2/dir.c:1479: warning: Function parameter or member 'f_ra' not described in 'gfs2_dir_readahead'
 fs/gfs2/dir.c:1528: warning: Function parameter or member 'inode' not described in 'dir_e_read'
 fs/gfs2/dir.c:1528: warning: Function parameter or member 'f_ra' not described in 'dir_e_read'
 fs/gfs2/dir.c:1528: warning: Excess function parameter 'dip' description in 'dir_e_read'
 fs/gfs2/dir.c:1642: warning: Function parameter or member 'dir' not described in 'gfs2_dir_search'
 fs/gfs2/dir.c:1642: warning: Excess function parameter 'dip' description in 'gfs2_dir_search'
 fs/gfs2/dir.c:1873: warning: Function parameter or member 'dentry' not described in 'gfs2_dir_del'
 fs/gfs2/dir.c:1873: warning: Excess function parameter 'filename' description in 'gfs2_dir_del'
 fs/gfs2/dir.c:1934: warning: Function parameter or member 'filename' not described in 'gfs2_dir_mvino'
 fs/gfs2/dir.c:1934: warning: Function parameter or member 'nip' not described in 'gfs2_dir_mvino'
 fs/gfs2/dir.c:1934: warning: Function parameter or member 'new_type' not described in 'gfs2_dir_mvino'
 fs/gfs2/dir.c:1934: warning: Excess function parameter 'new_inode' description in 'gfs2_dir_mvino'
 fs/gfs2/dir.c:1971: warning: Function parameter or member 'last_dealloc' not described in 'leaf_dealloc'
 fs/gfs2/dir.c:2154: warning: Function parameter or member 'inode' not described in 'gfs2_diradd_alloc_required'
 fs/gfs2/dir.c:2154: warning: Function parameter or member 'name' not described in 'gfs2_diradd_alloc_required'
 fs/gfs2/dir.c:2154: warning: Excess function parameter 'ip' description in 'gfs2_diradd_alloc_required'
 fs/gfs2/dir.c:2154: warning: Excess function parameter 'filname' description in 'gfs2_diradd_alloc_required'

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

diff --git a/fs/gfs2/dir.c b/fs/gfs2/dir.c
index c0f2875c946c9..9c1caaef3f0cd 100644
--- a/fs/gfs2/dir.c
+++ b/fs/gfs2/dir.c
@@ -767,7 +767,7 @@ static int get_leaf(struct gfs2_inode *dip, u64 leaf_no,
 	return error;
 }
 
-/**
+/*
  * get_leaf_nr - Get a leaf number associated with the index
  * @dip: The GFS2 inode
  * @index:
@@ -775,7 +775,6 @@ static int get_leaf(struct gfs2_inode *dip, u64 leaf_no,
  *
  * Returns: 0 on success, error code otherwise
  */
-
 static int get_leaf_nr(struct gfs2_inode *dip, u32 index,
 		       u64 *leaf_out)
 {
@@ -898,7 +897,7 @@ static struct gfs2_leaf *new_leaf(struct inode *inode, struct buffer_head **pbh,
 
 /**
  * dir_make_exhash - Convert a stuffed directory into an ExHash directory
- * @dip: The GFS2 inode
+ * @inode: The GFS2 inode
  *
  * Returns: 0 on success, error code otherwise
  */
@@ -989,11 +988,9 @@ static int dir_make_exhash(struct inode *inode)
 	return 0;
 }
 
-/**
+/*
  * dir_split_leaf - Split a leaf block into two
- * @dip: The GFS2 inode
- * @index:
- * @leaf_no:
+ * @inode: The GFS2 inode
  *
  * Returns: 0 on success, error code on failure
  */
@@ -1252,6 +1249,7 @@ static int compare_dents(const void *a, const void *b)
  * @ctx: what to feed the entries to
  * @darr: an array of struct gfs2_dirent pointers to read
  * @entries: the number of entries in darr
+ * @sort_start: the index into @darr to start the sort from
  * @copied: pointer to int that's non-zero if a entry has been copied out
  *
  * Jump through some hoops to make sure that if there are hash collsions,
@@ -1466,7 +1464,7 @@ static int gfs2_dir_read_leaf(struct inode *inode, struct dir_context *ctx,
 	return error;
 }
 
-/**
+/*
  * gfs2_dir_readahead - Issue read-ahead requests for leaf blocks.
  *
  * Note: we can't calculate each index like dir_e_read can because we don't
@@ -1515,14 +1513,11 @@ static void gfs2_dir_readahead(struct inode *inode, unsigned hsize, u32 index,
 	}
 }
 
-/**
+/*
  * dir_e_read - Reads the entries from a directory into a filldir buffer
- * @dip: dinode pointer
- * @ctx: actor to feed the entries to
  *
  * Returns: errno
  */
-
 static int dir_e_read(struct inode *inode, struct dir_context *ctx,
 		      struct file_ra_state *f_ra)
 {
@@ -1627,7 +1622,7 @@ int gfs2_dir_read(struct inode *inode, struct dir_context *ctx,
 
 /**
  * gfs2_dir_search - Search a directory
- * @dip: The GFS2 dir inode
+ * @dir: The GFS2 dir inode
  * @name: The name we are looking up
  * @fail_on_exist: Fail if the name exists rather than looking it up
  *
@@ -1636,7 +1631,6 @@ int gfs2_dir_read(struct inode *inode, struct dir_context *ctx,
  *
  * Returns: errno
  */
-
 struct inode *gfs2_dir_search(struct inode *dir, const struct qstr *name,
 			      bool fail_on_exist)
 {
@@ -1864,11 +1858,10 @@ int gfs2_dir_add(struct inode *inode, const struct qstr *name,
 /**
  * gfs2_dir_del - Delete a directory entry
  * @dip: The GFS2 inode
- * @filename: The filename
+ * @dentry: The directory entry to delete
  *
  * Returns: 0 on success, error code on failure
  */
-
 int gfs2_dir_del(struct gfs2_inode *dip, const struct dentry *dentry)
 {
 	const struct qstr *name = &dentry->d_name;
@@ -1916,11 +1909,9 @@ int gfs2_dir_del(struct gfs2_inode *dip, const struct dentry *dentry)
 	return 0;
 }
 
-/**
+/*
  * gfs2_dir_mvino - Change inode number of directory entry
  * @dip: The GFS2 inode
- * @filename:
- * @new_inode:
  *
  * This routine changes the inode number of a directory entry.  It's used
  * by rename to change ".." when a directory is moved.
@@ -1960,7 +1951,7 @@ int gfs2_dir_mvino(struct gfs2_inode *dip, const struct qstr *filename,
  * @len: the number of pointers to this leaf
  * @leaf_no: the leaf number
  * @leaf_bh: buffer_head for the starting leaf
- * last_dealloc: 1 if this is the final dealloc for the leaf, else 0
+ * @last_dealloc: 1 if this is the final dealloc for the leaf, else 0
  *
  * Returns: errno
  */
@@ -2142,8 +2133,8 @@ int gfs2_dir_exhash_dealloc(struct gfs2_inode *dip)
 
 /**
  * gfs2_diradd_alloc_required - find if adding entry will require an allocation
- * @ip: the file being written to
- * @filname: the filename that's going to be added
+ * @inode: The directory inode
+ * @name: the filename that's going to be added
  * @da: The structure to return dir alloc info
  *
  * Returns: 0 if ok, -ve on error
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 02/31] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 03/31] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others Lee Jones
                   ` (16 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/xattr.c:41: warning: Function parameter or member 'sdp' not described in 'ea_calc_size'
 fs/gfs2/xattr.c:41: warning: Function parameter or member 'nsize' not described in 'ea_calc_size'
 fs/gfs2/xattr.c:41: warning: Function parameter or member 'dsize' not described in 'ea_calc_size'
 fs/gfs2/xattr.c:240: warning: Function parameter or member 'ip' not described in 'ea_dealloc_unstuffed'
 fs/gfs2/xattr.c:240: warning: Function parameter or member 'bh' not described in 'ea_dealloc_unstuffed'
 fs/gfs2/xattr.c:240: warning: Function parameter or member 'ea' not described in 'ea_dealloc_unstuffed'
 fs/gfs2/xattr.c:240: warning: Function parameter or member 'prev' not described in 'ea_dealloc_unstuffed'
 fs/gfs2/xattr.c:463: warning: expecting prototype for ea_iter_unstuffed(). Prototype was for gfs2_iter_unstuffed() instead
 fs/gfs2/xattr.c:587: warning: expecting prototype for gfs2_xattr_get(). Prototype was for __gfs2_xattr_get() instead
 fs/gfs2/xattr.c:814: warning: Function parameter or member 'ip' not described in 'ea_init'
 fs/gfs2/xattr.c:814: warning: Function parameter or member 'type' not described in 'ea_init'
 fs/gfs2/xattr.c:814: warning: Function parameter or member 'name' not described in 'ea_init'
 fs/gfs2/xattr.c:814: warning: Function parameter or member 'data' not described in 'ea_init'
 fs/gfs2/xattr.c:814: warning: Function parameter or member 'size' not described in 'ea_init'
 fs/gfs2/xattr.c:814: warning: Excess function parameter 'er' description in 'ea_init'
 fs/gfs2/xattr.c:1181: warning: Function parameter or member 'inode' not described in '__gfs2_xattr_set'
 fs/gfs2/xattr.c:1181: warning: Excess function parameter 'ip' description in '__gfs2_xattr_set'

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

diff --git a/fs/gfs2/xattr.c b/fs/gfs2/xattr.c
index 124b3d5a72665..fe2109789f75b 100644
--- a/fs/gfs2/xattr.c
+++ b/fs/gfs2/xattr.c
@@ -26,12 +26,9 @@
 #include "trans.h"
 #include "util.h"
 
-/**
+/*
  * ea_calc_size - returns the acutal number of bytes the request will take up
  *                (not counting any unstuffed data blocks)
- * @sdp:
- * @er:
- * @size:
  *
  * Returns: 1 if the EA should be stuffed
  */
@@ -219,13 +216,8 @@ static int gfs2_ea_find(struct gfs2_inode *ip, int type, const char *name,
 	return error;
 }
 
-/**
+/*
  * ea_dealloc_unstuffed -
- * @ip:
- * @bh:
- * @ea:
- * @prev:
- * @private:
  *
  * Take advantage of the fact that all unstuffed blocks are
  * allocated from the same RG.  But watch, this may not always
@@ -448,8 +440,8 @@ ssize_t gfs2_listxattr(struct dentry *dentry, char *buffer, size_t size)
 }
 
 /**
- * ea_iter_unstuffed - copies the unstuffed xattr data to/from the
- *                     request buffer
+ * gfs2_iter_unstuffed - copies the unstuffed xattr data to/from the
+ *                       request buffer
  * @ip: The GFS2 inode
  * @ea: The extended attribute header structure
  * @din: The data to be copied in
@@ -573,7 +565,7 @@ int gfs2_xattr_acl_get(struct gfs2_inode *ip, const char *name, char **ppdata)
 }
 
 /**
- * gfs2_xattr_get - Get a GFS2 extended attribute
+ * __gfs2_xattr_get - Get a GFS2 extended attribute
  * @inode: The inode
  * @name: The name of the extended attribute
  * @buffer: The buffer to write the result into
@@ -801,14 +793,11 @@ static int ea_init_i(struct gfs2_inode *ip, struct gfs2_ea_request *er,
 	return error;
 }
 
-/**
+/*
  * ea_init - initializes a new eattr block
- * @ip:
- * @er:
  *
  * Returns: errno
  */
-
 static int ea_init(struct gfs2_inode *ip, int type, const char *name,
 		   const void *data, size_t size)
 {
@@ -1164,7 +1153,7 @@ static int gfs2_xattr_remove(struct gfs2_inode *ip, int type, const char *name)
 
 /**
  * __gfs2_xattr_set - Set (or remove) a GFS2 extended attribute
- * @ip: The inode
+ * @inode: The inode
  * @name: The name of the extended attribute
  * @value: The value of the extended attribute (NULL for remove)
  * @size: The size of the @value argument
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 03/31] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 02/31] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 04/31] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others Lee Jones
                   ` (15 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/bmap.c:1502: warning: Function parameter or member 'rd_gh' not described in 'sweep_bh_for_rgrps'
 fs/gfs2/bmap.c:1502: warning: Excess function parameter 'rg_gh' description in 'sweep_bh_for_rgrps'
 fs/gfs2/bmap.c:1671: warning: Function parameter or member 'sdp' not described in 'find_nonnull_ptr'
 fs/gfs2/bmap.c:1671: warning: Function parameter or member 'end_list' not described in 'find_nonnull_ptr'
 fs/gfs2/bmap.c:1671: warning: Function parameter or member 'end_aligned' not described in 'find_nonnull_ptr'

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

diff --git a/fs/gfs2/bmap.c b/fs/gfs2/bmap.c
index 7a358ae051851..7ff20db4999fb 100644
--- a/fs/gfs2/bmap.c
+++ b/fs/gfs2/bmap.c
@@ -1477,7 +1477,7 @@ int gfs2_iomap_get_alloc(struct inode *inode, loff_t pos, loff_t length,
 /**
  * sweep_bh_for_rgrps - find an rgrp in a meta buffer and free blocks therein
  * @ip: inode
- * @rg_gh: holder of resource group glock
+ * @rd_gh: holder of resource group glock
  * @bh: buffer head to sweep
  * @start: starting point in bh
  * @end: end point in bh
@@ -1656,7 +1656,7 @@ static bool mp_eq_to_hgt(struct metapath *mp, __u16 *list, unsigned int h)
 	return true;
 }
 
-/**
+/*
  * find_nonnull_ptr - find a non-null pointer given a metapath and height
  * @mp: starting metapath
  * @h: desired height to search
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 04/31] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (2 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 03/31] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers Lee Jones
                   ` (14 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/glops.c:58: warning: Function parameter or member 'nr_revokes' not described in '__gfs2_ail_flush'
 fs/gfs2/glops.c:490: warning: Function parameter or member 'gh' not described in 'inode_go_lock'
 fs/gfs2/glops.c:490: warning: Excess function parameter 'gl' description in 'inode_go_lock'
 fs/gfs2/glops.c:490: warning: Excess function parameter 'flags' description in 'inode_go_lock'
 fs/gfs2/glops.c:532: warning: Function parameter or member 'gl' not described in 'inode_go_dump'
 fs/gfs2/glops.c:532: warning: Excess function parameter 'ip' description in 'inode_go_dump'
 fs/gfs2/glops.c:562: warning: Excess function parameter 'state' description in 'freeze_go_sync'
 fs/gfs2/glops.c:562: warning: Excess function parameter 'flags' description in 'freeze_go_sync'
 fs/gfs2/glops.c:607: warning: Function parameter or member 'gh' not described in 'freeze_go_xmote_bh'
 fs/gfs2/glops.c:640: warning: expecting prototype for trans_go_demote_ok(). Prototype was for freeze_go_demote_ok() instead
 fs/gfs2/glops.c:651: warning: Function parameter or member 'remote' not described in 'iopen_go_callback'

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

diff --git a/fs/gfs2/glops.c b/fs/gfs2/glops.c
index ef0b583c3417c..5711b2c8de9e2 100644
--- a/fs/gfs2/glops.c
+++ b/fs/gfs2/glops.c
@@ -49,6 +49,7 @@ static void gfs2_ail_error(struct gfs2_glock *gl, const struct buffer_head *bh)
  * __gfs2_ail_flush - remove all buffers for a given lock from the AIL
  * @gl: the glock
  * @fsync: set when called from fsync (not all buffers will be clean)
+ * @nr_revokes: Number of buffers to revoke
  *
  * None of the buffers should be dirty, locked, or pinned.
  */
@@ -478,10 +479,8 @@ int gfs2_inode_refresh(struct gfs2_inode *ip)
 	return error;
 }
 
-/**
+/*
  * inode_go_lock - operation done after an inode lock is locked by a process
- * @gl: the glock
- * @flags:
  *
  * Returns: errno
  */
@@ -522,7 +521,7 @@ static int inode_go_lock(struct gfs2_holder *gh)
 /**
  * inode_go_dump - print information about an inode
  * @seq: The iterator
- * @ip: the inode
+ * @gl: The glock
  * @fs_id_buf: file system id (may be empty)
  *
  */
@@ -553,9 +552,6 @@ static void inode_go_dump(struct seq_file *seq, struct gfs2_glock *gl,
 /**
  * freeze_go_sync - promote/demote the freeze glock
  * @gl: the glock
- * @state: the requested state
- * @flags:
- *
  */
 
 static int freeze_go_sync(struct gfs2_glock *gl)
@@ -597,12 +593,10 @@ static int freeze_go_sync(struct gfs2_glock *gl)
 	return 0;
 }
 
-/**
+/*
  * freeze_go_xmote_bh - After promoting/demoting the freeze glock
  * @gl: the glock
- *
  */
-
 static int freeze_go_xmote_bh(struct gfs2_glock *gl, struct gfs2_holder *gh)
 {
 	struct gfs2_sbd *sdp = gl->gl_name.ln_sbd;
@@ -630,7 +624,7 @@ static int freeze_go_xmote_bh(struct gfs2_glock *gl, struct gfs2_holder *gh)
 }
 
 /**
- * trans_go_demote_ok
+ * freeze_go_demote_ok()
  * @gl: the glock
  *
  * Always returns 0
@@ -641,7 +635,7 @@ static int freeze_go_demote_ok(const struct gfs2_glock *gl)
 	return 0;
 }
 
-/**
+/*
  * iopen_go_callback - schedule the dcache entry for the inode to be deleted
  * @gl: the glock
  *
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (3 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 04/31] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 06/31] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others Lee Jones
                   ` (13 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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 at 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



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 06/31] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (4 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 07/31] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones Lee Jones
                   ` (12 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/lops.c:106: warning: Function parameter or member 'tr' not described in 'gfs2_unpin'
 fs/gfs2/lops.c:106: warning: Excess function parameter 'flags' description in 'gfs2_unpin'
 fs/gfs2/lops.c:300: warning: Function parameter or member 'biop' not described in 'gfs2_log_get_bio'
 fs/gfs2/lops.c:300: warning: Excess function parameter 'bio' description in 'gfs2_log_get_bio'
 fs/gfs2/lops.c:333: warning: Function parameter or member 'jd' not described in 'gfs2_log_write'
 fs/gfs2/lops.c:428: warning: Function parameter or member 'head' not described in 'gfs2_jhead_pg_srch'
 fs/gfs2/lops.c:471: warning: Function parameter or member 'head' not described in 'gfs2_jhead_process_page'
 fs/gfs2/lops.c:513: warning: Function parameter or member 'keep_cache' not described in 'gfs2_find_jhead'
 fs/gfs2/lops.c:983: warning: Function parameter or member 'sdp' not described in 'databuf_lo_before_commit'
 fs/gfs2/lops.c:983: warning: Function parameter or member 'tr' not described in 'databuf_lo_before_commit'

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

diff --git a/fs/gfs2/lops.c b/fs/gfs2/lops.c
index a82f4747aa8d5..390ac939aa757 100644
--- a/fs/gfs2/lops.c
+++ b/fs/gfs2/lops.c
@@ -92,13 +92,10 @@ static void maybe_release_space(struct gfs2_bufdata *bd)
 	rgrp_unlock_local(rgd);
 }
 
-/**
+/*
  * gfs2_unpin - Unpin a buffer
  * @sdp: the filesystem the buffer belongs to
  * @bh: The buffer to unpin
- * @ai:
- * @flags: The inode dirty flags
- *
  */
 
 static void gfs2_unpin(struct gfs2_sbd *sdp, struct buffer_head *bh,
@@ -281,7 +278,7 @@ static struct bio *gfs2_log_alloc_bio(struct gfs2_sbd *sdp, u64 blkno,
  * gfs2_log_get_bio - Get cached log bio, or allocate a new one
  * @sdp: The super block
  * @blkno: The device block number we want to write to
- * @bio: The bio to get or allocate
+ * @biop: The bio to get or allocate
  * @op: REQ_OP
  * @end_io: The bi_end_io callback
  * @flush: Always flush the current bio and allocate a new one?
@@ -317,6 +314,7 @@ static struct bio *gfs2_log_get_bio(struct gfs2_sbd *sdp, u64 blkno,
 /**
  * gfs2_log_write - write to log
  * @sdp: the filesystem
+ * @jd: The journal descriptor
  * @page: the page to write
  * @size: the size of the data to write
  * @offset: the offset within the page 
@@ -417,6 +415,7 @@ static void gfs2_end_log_read(struct bio *bio)
 /**
  * gfs2_jhead_pg_srch - Look for the journal head in a given page.
  * @jd: The journal descriptor
+ * @head: the head journal to start from
  * @page: The page to look in
  *
  * Returns: 1 if found, 0 otherwise.
@@ -450,6 +449,7 @@ static bool gfs2_jhead_pg_srch(struct gfs2_jdesc *jd,
  * gfs2_jhead_process_page - Search/cleanup a page
  * @jd: The journal descriptor
  * @index: Index of the page to look into
+ * @head: the head journal to start from
  * @done: If set, perform only cleanup, else search and set if found.
  *
  * Find the page with 'index' in the journal's mapping. Search the page for
@@ -502,6 +502,7 @@ static struct bio *gfs2_chain_bio(struct bio *prev, unsigned int nr_iovecs)
  * gfs2_find_jhead - find the head of a log
  * @jd: The journal descriptor
  * @head: The log descriptor for the head of the log is returned here
+ * @keep_cache: If set inode pages will not be truncated
  *
  * Do a search of a journal by reading it in large chunks using bios and find
  * the valid log entry with the highest sequence number.  (i.e. the log head)
@@ -974,7 +975,7 @@ static void revoke_lo_after_scan(struct gfs2_jdesc *jd, int error, int pass)
 	gfs2_revoke_clean(jd);
 }
 
-/**
+/*
  * databuf_lo_before_commit - Scan the data buffers, writing as we go
  *
  */
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 07/31] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (5 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 06/31] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 08/31] fs: gfs2: aops: Fix a little potential doc-rot Lee Jones
                   ` (11 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/glock.c:365: warning: Function parameter or member 'gl' not described in 'do_error'
 fs/gfs2/glock.c:365: warning: Function parameter or member 'ret' not described in 'do_error'
 fs/gfs2/glock.c:461: warning: Function parameter or member 'new_state' not described in 'state_change'
 fs/gfs2/glock.c:1277: warning: Function parameter or member 'delay' not described in 'handle_callback'
 fs/gfs2/glock.c:1277: warning: Function parameter or member 'remote' not described in 'handle_callback'
 fs/gfs2/glock.c:1578: warning: Function parameter or member 'p' not described in 'nq_m_sync'
 fs/gfs2/glock.c:1993: warning: Excess function parameter 'wait' description in 'gfs2_gl_hash_clear'

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

diff --git a/fs/gfs2/glock.c b/fs/gfs2/glock.c
index 7cccc5e863a8a..c590e27aaf097 100644
--- a/fs/gfs2/glock.c
+++ b/fs/gfs2/glock.c
@@ -356,7 +356,7 @@ static void gfs2_holder_wake(struct gfs2_holder *gh)
 	}
 }
 
-/**
+/*
  * do_error - Something unexpected has happened during a lock request
  *
  */
@@ -453,8 +453,7 @@ static inline struct gfs2_holder *find_first_waiter(const struct gfs2_glock *gl)
 /**
  * state_change - record that the glock is now in a different state
  * @gl: the glock
- * @new_state the new state
- *
+ * @new_state: the new state
  */
 
 static void state_change(struct gfs2_glock *gl, unsigned int new_state)
@@ -1263,7 +1262,7 @@ int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs)
 	return ret;
 }
 
-/**
+/*
  * handle_callback - process a demote request
  * @gl: the glock
  * @state: the state the caller wants us to change to
@@ -1568,6 +1567,7 @@ static int glock_compare(const void *arg_a, const void *arg_b)
  * nq_m_sync - synchonously acquire more than one glock in deadlock free order
  * @num_gh: the number of structures
  * @ghs: an array of struct gfs2_holder structures
+ * @p: placeholder for the holder structure to pass back
  *
  * Returns: 0 on success (all glocks acquired),
  *          errno on failure (no glocks acquired)
@@ -1984,7 +1984,6 @@ static void dump_glock_func(struct gfs2_glock *gl)
 /**
  * gfs2_gl_hash_clear - Empty out the glock hash table
  * @sdp: the filesystem
- * @wait: wait until it's all gone
  *
  * Called when unmounting the filesystem.
  */
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 08/31] fs: gfs2: aops: Fix a little potential doc-rot
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (6 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 07/31] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 09/31] fs: gfs2: meta_io: Add missing description for 'rahead' param Lee Jones
                   ` (10 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/aops.c:560: warning: Function parameter or member 'rac' not described in 'gfs2_readahead'
 fs/gfs2/aops.c:560: warning: Excess function parameter 'file' description in 'gfs2_readahead'
 fs/gfs2/aops.c:560: warning: Excess function parameter 'mapping' description in 'gfs2_readahead'
 fs/gfs2/aops.c:560: warning: Excess function parameter 'pages' description in 'gfs2_readahead'
 fs/gfs2/aops.c:560: warning: Excess function parameter 'nr_pages' description in 'gfs2_readahead'

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

diff --git a/fs/gfs2/aops.c b/fs/gfs2/aops.c
index cc4f987687f3c..23b5be3db044c 100644
--- a/fs/gfs2/aops.c
+++ b/fs/gfs2/aops.c
@@ -540,10 +540,7 @@ int gfs2_internal_read(struct gfs2_inode *ip, char *buf, loff_t *pos,
 
 /**
  * gfs2_readahead - Read a bunch of pages at once
- * @file: The file to read from
- * @mapping: Address space info
- * @pages: List of pages to read
- * @nr_pages: Number of pages to read
+ * @rac: Read-ahead control structure
  *
  * Some notes:
  * 1. This is only for readahead, so we can simply ignore any things
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 09/31] fs: gfs2: meta_io: Add missing description for 'rahead' param
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (7 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 08/31] fs: gfs2: aops: Fix a little potential doc-rot Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 10/31] fs: gfs2: inode: Fix worthy function headers demote others Lee Jones
                   ` (9 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/meta_io.c:249: warning: Function parameter or member 'rahead' not described in 'gfs2_meta_read'

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

diff --git a/fs/gfs2/meta_io.c b/fs/gfs2/meta_io.c
index c38e3805f4689..9f01df6a84911 100644
--- a/fs/gfs2/meta_io.c
+++ b/fs/gfs2/meta_io.c
@@ -243,6 +243,7 @@ static void gfs2_submit_bhs(int op, int op_flags, struct buffer_head *bhs[],
  * @gl: The glock covering the block
  * @blkno: The block number
  * @flags: flags
+ * @rahead: Do read-ahead
  * @bhp: the place where the buffer is returned (NULL on failure)
  *
  * Returns: errno
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 10/31] fs: gfs2: inode: Fix worthy function headers demote others
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (8 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 09/31] fs: gfs2: meta_io: Add missing description for 'rahead' param Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 11/31] fs: gfs2: file: Strip out superfluous param description and demote kernel-doc abuse Lee Jones
                   ` (8 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/inode.c:303: warning: Function parameter or member 'dir' not described in 'gfs2_lookupi'
 fs/gfs2/inode.c:303: warning: Excess function parameter 'd_gh' description in 'gfs2_lookupi'
 fs/gfs2/inode.c:303: warning: Excess function parameter 'i_gh' description in 'gfs2_lookupi'
 fs/gfs2/inode.c:485: warning: Excess function parameter 'bhp' description in 'init_dinode'
 fs/gfs2/inode.c:533: warning: expecting prototype for gfs2_trans_da_blocks(). Prototype was for gfs2_trans_da_blks() instead
 fs/gfs2/inode.c:606: warning: Function parameter or member 'excl' not described in 'gfs2_create_inode'
 fs/gfs2/inode.c:849: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_create'
 fs/gfs2/inode.c:849: warning: Function parameter or member 'excl' not described in 'gfs2_create'
 fs/gfs2/inode.c:1094: warning: Function parameter or member 'dentry' not described in 'gfs2_unlink_inode'
 fs/gfs2/inode.c:1094: warning: Excess function parameter 'name' description in 'gfs2_unlink_inode'
 fs/gfs2/inode.c:1094: warning: Excess function parameter 'inode' description in 'gfs2_unlink_inode'
 fs/gfs2/inode.c:1211: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_symlink'
 fs/gfs2/inode.c:1232: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_mkdir'
 fs/gfs2/inode.c:1248: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_mknod'
 fs/gfs2/inode.c:1845: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_permission'
 fs/gfs2/inode.c:1845: warning: Excess function parameter 'flags' description in 'gfs2_permission'
 fs/gfs2/inode.c:1886: warning: Function parameter or member 'inode' not described in 'gfs2_setattr_simple'
 fs/gfs2/inode.c:1976: warning: Function parameter or member 'mnt_userns' not described in 'gfs2_setattr'

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

diff --git a/fs/gfs2/inode.c b/fs/gfs2/inode.c
index c9775d5c65949..8b1dfdb60d508 100644
--- a/fs/gfs2/inode.c
+++ b/fs/gfs2/inode.c
@@ -285,10 +285,9 @@ struct inode *gfs2_lookup_simple(struct inode *dip, const char *name)
 
 /**
  * gfs2_lookupi - Look up a filename in a directory and return its inode
- * @d_gh: An initialized holder for the directory glock
+ * @dir: The inode of the directory containing the inode to look-up
  * @name: The name of the inode to look for
  * @is_root: If 1, ignore the caller's permissions
- * @i_gh: An uninitialized holder for the new inode glock
  *
  * This can be called via the VFS filldir function when NFS is doing
  * a readdirplus and the inode which its intending to stat isn't
@@ -476,7 +475,6 @@ static void gfs2_init_xattr(struct gfs2_inode *ip)
  * @dip: The directory this inode is being created in
  * @ip: The inode
  * @symname: The symlink destination (if a symlink)
- * @bhp: The buffer head (returned to caller)
  *
  */
 
@@ -514,7 +512,7 @@ static void init_dinode(struct gfs2_inode *dip, struct gfs2_inode *ip,
 }
 
 /**
- * gfs2_trans_da_blocks - Calculate number of blocks to link inode
+ * gfs2_trans_da_blks - Calculate number of blocks to link inode
  * @dip: The directory we are linking into
  * @da: The dir add information
  * @nr_inodes: The number of inodes involved
@@ -595,6 +593,7 @@ static int gfs2_initxattrs(struct inode *inode, const struct xattr *xattr_array,
  * @dev: For device nodes, this is the device number
  * @symname: For symlinks, this is the link destination
  * @size: The initial size of the inode (ignored for directories)
+ * @excl: Force fail if directory exists
  *
  * Returns: 0 on success, or error code
  */
@@ -837,9 +836,11 @@ static int gfs2_create_inode(struct inode *dir, struct dentry *dentry,
 
 /**
  * gfs2_create - Create a file
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @dir: The directory in which to create the file
  * @dentry: The dentry of the new file
  * @mode: The mode of the new file
+ * @excl: Frorce fail if exists
  *
  * Returns: errno
  */
@@ -1080,8 +1081,7 @@ static int gfs2_unlink_ok(struct gfs2_inode *dip, const struct qstr *name,
 /**
  * gfs2_unlink_inode - Removes an inode from its parent dir and unlinks it
  * @dip: The parent directory
- * @name: The name of the entry in the parent directory
- * @inode: The inode to be removed
+ * @dentry: The dentry to unlink
  *
  * Called with all the locks and in a transaction. This will only be
  * called for a directory after it has been checked to ensure it is empty.
@@ -1199,6 +1199,7 @@ static int gfs2_unlink(struct inode *dir, struct dentry *dentry)
 
 /**
  * gfs2_symlink - Create a symlink
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @dir: The directory to create the symlink in
  * @dentry: The dentry to put the symlink in
  * @symname: The thing which the link points to
@@ -1220,6 +1221,7 @@ static int gfs2_symlink(struct user_namespace *mnt_userns, struct inode *dir,
 
 /**
  * gfs2_mkdir - Make a directory
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @dir: The parent directory of the new one
  * @dentry: The dentry of the new directory
  * @mode: The mode of the new directory
@@ -1236,6 +1238,7 @@ static int gfs2_mkdir(struct user_namespace *mnt_userns, struct inode *dir,
 
 /**
  * gfs2_mknod - Make a special file
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @dir: The directory in which the special file will reside
  * @dentry: The dentry of the special file
  * @mode: The mode of the special file
@@ -1829,9 +1832,9 @@ static const char *gfs2_get_link(struct dentry *dentry,
 
 /**
  * gfs2_permission -
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @inode: The inode
  * @mask: The mask to be tested
- * @flags: Indicates whether this is an RCU path walk or not
  *
  * This may be called from the VFS directly, or from within GFS2 with the
  * inode locked, so we look to see if the glock is already locked and only
@@ -1874,10 +1877,8 @@ static int __gfs2_setattr_simple(struct inode *inode, struct iattr *attr)
 	return 0;
 }
 
-/**
+/*
  * gfs2_setattr_simple -
- * @ip:
- * @attr:
  *
  * Returns: errno
  */
@@ -1962,6 +1963,7 @@ static int setattr_chown(struct inode *inode, struct iattr *attr)
 
 /**
  * gfs2_setattr - Change attributes on an inode
+ * @mnt_userns: User namespace of the mount the inode was found from
  * @dentry: The dentry which is changing
  * @attr: The structure describing the change
  *
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 11/31] fs: gfs2: file: Strip out superfluous param description and demote kernel-doc abuse
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (9 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 10/31] fs: gfs2: inode: Fix worthy function headers demote others Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 12/31] fs: gfs2: ops_fstype: Fix a little doc-rot Lee Jones
                   ` (7 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/file.c:127: warning: cannot understand function prototype: 'struct '
 fs/gfs2/file.c:446: warning: Excess function parameter 'vma' description in 'gfs2_page_mkwrite'

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

diff --git a/fs/gfs2/file.c b/fs/gfs2/file.c
index 2d500f90cdacf..afab20e5954fd 100644
--- a/fs/gfs2/file.c
+++ b/fs/gfs2/file.c
@@ -118,7 +118,7 @@ static int gfs2_readdir(struct file *file, struct dir_context *ctx)
 	return error;
 }
 
-/**
+/*
  * fsflag_gfs2flag
  *
  * The FS_JOURNAL_DATA_FL flag maps to GFS2_DIF_INHERIT_JDATA for directories,
@@ -435,7 +435,6 @@ static int gfs2_allocate_page_backing(struct page *page, unsigned int length)
 
 /**
  * gfs2_page_mkwrite - Make a shared, mmap()ed, page writable
- * @vma: The virtual memory area
  * @vmf: The virtual memory fault containing the page to become writable
  *
  * When the page becomes writable, we need to ensure that we have
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 12/31] fs: gfs2: ops_fstype: Fix a little doc-rot
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (10 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 11/31] fs: gfs2: file: Strip out superfluous param description and demote kernel-doc abuse Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 13/31] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad' Lee Jones
                   ` (6 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/ops_fstype.c:162: warning: Excess function parameter 'sb' description in 'gfs2_check_sb'
 fs/gfs2/ops_fstype.c:242: warning: Function parameter or member 'silent' not described in 'gfs2_read_super'
 fs/gfs2/ops_fstype.c:242: warning: Excess function parameter 'error' description in 'gfs2_read_super'
 fs/gfs2/ops_fstype.c:993: warning: Excess function parameter 'args' description in 'gfs2_lm_mount'
 fs/gfs2/ops_fstype.c:1102: warning: Function parameter or member 'fc' not described in 'gfs2_fill_super'
 fs/gfs2/ops_fstype.c:1102: warning: Excess function parameter 'args' description in 'gfs2_fill_super'
 fs/gfs2/ops_fstype.c:1102: warning: Excess function parameter 'silent' description in 'gfs2_fill_super'

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

diff --git a/fs/gfs2/ops_fstype.c b/fs/gfs2/ops_fstype.c
index aa4136055a83c..b6c7a95dabf90 100644
--- a/fs/gfs2/ops_fstype.c
+++ b/fs/gfs2/ops_fstype.c
@@ -150,7 +150,6 @@ static struct gfs2_sbd *init_sbd(struct super_block *sb)
 /**
  * gfs2_check_sb - Check superblock
  * @sdp: the filesystem
- * @sb: The superblock
  * @silent: Don't print a message if the check fails
  *
  * Checks the version code of the FS is one that we understand how to
@@ -223,7 +222,7 @@ static void gfs2_sb_in(struct gfs2_sbd *sdp, const void *buf)
  * gfs2_read_super - Read the gfs2 super block from disk
  * @sdp: The GFS2 super block
  * @sector: The location of the super block
- * @error: The error code to return
+ * @silent: Don't print a message if the check fails
  *
  * This uses the bio functions to read the super block from disk
  * because we want to be 100% sure that we never read cached data.
@@ -983,7 +982,6 @@ static const struct lm_lockops nolock_ops = {
 /**
  * gfs2_lm_mount - mount a locking protocol
  * @sdp: the filesystem
- * @args: mount arguments
  * @silent: if 1, don't complain if the FS isn't a GFS2 fs
  *
  * Returns: errno
@@ -1093,8 +1091,7 @@ void gfs2_online_uevent(struct gfs2_sbd *sdp)
 /**
  * gfs2_fill_super - Read in superblock
  * @sb: The VFS superblock
- * @args: Mount options
- * @silent: Don't complain if it's not a GFS2 filesystem
+ * @fc: Mount options and flags
  *
  * Returns: -errno
  */
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 13/31] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad'
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (11 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 12/31] fs: gfs2: ops_fstype: Fix a little doc-rot Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 14/31] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours Lee Jones
                   ` (5 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/quota.c:1542: warning: Function parameter or member 'data' not described in 'gfs2_quotad'
 fs/gfs2/quota.c:1542: warning: Excess function parameter 'sdp' description in 'gfs2_quotad'

Cc: Bob Peterson <rpeterso@redhat.com>
Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: cluster-devel at redhat.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 fs/gfs2/quota.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/gfs2/quota.c b/fs/gfs2/quota.c
index 6e173ae378c44..33520eed467c2 100644
--- a/fs/gfs2/quota.c
+++ b/fs/gfs2/quota.c
@@ -1534,7 +1534,7 @@ void gfs2_wake_up_statfs(struct gfs2_sbd *sdp) {
 
 /**
  * gfs2_quotad - Write cached quota changes into the quota file
- * @sdp: Pointer to GFS2 superblock
+ * @data: Pointer to GFS2 superblock
  *
  */
 
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 14/31] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (12 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 13/31] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad' Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 15/31] fs: gfs2: recovery: Provide missing param descriptions and remove one other Lee Jones
                   ` (4 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/rgrp.c:755: warning: expecting prototype for gfs2_compute_bitstructs(). Prototype was for compute_bitstructs() instead
 fs/gfs2/rgrp.c:1549: warning: Function parameter or member 'rs' not described in 'rgd_free'
 fs/gfs2/rgrp.c:2027: warning: Function parameter or member 'rgd' not described in 'fast_to_acquire'

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

diff --git a/fs/gfs2/rgrp.c b/fs/gfs2/rgrp.c
index 89c37a845e649..88133c4ae8e93 100644
--- a/fs/gfs2/rgrp.c
+++ b/fs/gfs2/rgrp.c
@@ -743,7 +743,7 @@ void gfs2_clear_rgrpd(struct gfs2_sbd *sdp)
 }
 
 /**
- * gfs2_compute_bitstructs - Compute the bitmap sizes
+ * compute_bitstructs - Compute the bitmap sizes
  * @rgd: The resource group descriptor
  *
  * Calculates bitmap descriptors, one for each block that contains bitmap data
@@ -1536,6 +1536,7 @@ static void rs_insert(struct gfs2_inode *ip)
 /**
  * rgd_free - return the number of free blocks we can allocate.
  * @rgd: the resource group
+ * @rs: The reservation to free
  *
  * This function returns the number of free blocks for an rgrp.
  * That's the clone-free blocks (blocks that are free, not including those
@@ -2019,6 +2020,7 @@ static bool gfs2_select_rgrp(struct gfs2_rgrpd **pos, const struct gfs2_rgrpd *b
 
 /**
  * fast_to_acquire - determine if a resource group will be fast to acquire
+ * @rgd: The rgrp
  *
  * If this is one of our preferred rgrps, it should be quicker to acquire,
  * because we tried to set ourselves up as dlm lock master.
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 15/31] fs: gfs2: recovery: Provide missing param descriptions and remove one other
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (13 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 14/31] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 16/31] fs: gfs2: super: Fix kernel-doc issues where feasible demote " Lee Jones
                   ` (3 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/recovery.c:169: warning: Function parameter or member 'head' not described in 'get_log_header'
 fs/gfs2/recovery.c:169: warning: Excess function parameter 'lh' description in 'get_log_header'
 fs/gfs2/recovery.c:199: warning: Function parameter or member 'pass' not described in 'foreach_descriptor'

Cc: Bob Peterson <rpeterso@redhat.com>
Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: cluster-devel at redhat.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 fs/gfs2/recovery.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/fs/gfs2/recovery.c b/fs/gfs2/recovery.c
index 2821737740055..26004d5431165 100644
--- a/fs/gfs2/recovery.c
+++ b/fs/gfs2/recovery.c
@@ -154,7 +154,7 @@ int __get_log_header(struct gfs2_sbd *sdp, const struct gfs2_log_header *lh,
  * get_log_header - read the log header for a given segment
  * @jd: the journal
  * @blk: the block to look at
- * @lh: the log header to return
+ * @head: the log header to return
  *
  * Read the log header for a given segement in a given journal.  Do a few
  * sanity checks on it.
@@ -187,6 +187,7 @@ static int get_log_header(struct gfs2_jdesc *jd, unsigned int blk,
  * @jd: the journal
  * @start: the first log header in the active region
  * @end: the last log header (don't process the contents of this entry))
+ * @pass: iteration number (foreach_descriptor() is called in a for() loop)
  *
  * Call a given function once for every log descriptor in the active
  * portion of the log.
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 16/31] fs: gfs2: super: Fix kernel-doc issues where feasible demote one other
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (14 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 15/31] fs: gfs2: recovery: Provide missing param descriptions and remove one other Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 17/31] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses Lee Jones
                   ` (2 subsequent siblings)
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/super.c:397: warning: Excess function parameter 'state' description in 'gfs2_lock_fs_check_clean'
 fs/gfs2/super.c:397: warning: Excess function parameter 't_gh' description in 'gfs2_lock_fs_check_clean'
 fs/gfs2/super.c:709: warning: Function parameter or member 'wait' not described in 'gfs2_sync_fs'
 fs/gfs2/super.c:821: warning: expecting prototype for statfs_fill(). Prototype was for statfs_slow_fill() instead
 fs/gfs2/super.c:916: warning: Function parameter or member 'sc' not described in 'gfs2_statfs_i'
 fs/gfs2/super.c:916: warning: Excess function parameter 'sg' description in 'gfs2_statfs_i'
 fs/gfs2/super.c:948: warning: Function parameter or member 'dentry' not described in 'gfs2_statfs'
 fs/gfs2/super.c:948: warning: Function parameter or member 'buf' not described in 'gfs2_statfs'
 fs/gfs2/super.c:948: warning: Excess function parameter 'sb' description in 'gfs2_statfs'
 fs/gfs2/super.c:948: warning: Excess function parameter 'statfsbuf' description in 'gfs2_statfs'
 fs/gfs2/super.c:1281: warning: Function parameter or member 'gh' not described in 'evict_should_delete'

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

diff --git a/fs/gfs2/super.c b/fs/gfs2/super.c
index 669ce921d0096..841b430d532cd 100644
--- a/fs/gfs2/super.c
+++ b/fs/gfs2/super.c
@@ -387,8 +387,6 @@ struct lfcc {
  * gfs2_lock_fs_check_clean - Stop all writes to the FS and check that all
  *                            journals are clean
  * @sdp: the file system
- * @state: the state to put the transaction lock into
- * @t_gh: the hold on the transaction lock
  *
  * Returns: errno
  */
@@ -698,7 +696,7 @@ static void gfs2_put_super(struct super_block *sb)
 	free_sbd(sdp);
 }
 
-/**
+/*
  * gfs2_sync_fs - sync the filesystem
  * @sb: the superblock
  *
@@ -811,7 +809,7 @@ static int gfs2_unfreeze(struct super_block *sb)
 }
 
 /**
- * statfs_fill - fill in the sg for a given RG
+ * statfs_slow_fill - fill in the sg for a given RG
  * @rgd: the RG
  * @sc: the sc structure
  *
@@ -909,7 +907,7 @@ static int gfs2_statfs_slow(struct gfs2_sbd *sdp, struct gfs2_statfs_change_host
 /**
  * gfs2_statfs_i - Do a statfs
  * @sdp: the filesystem
- * @sg: the sg structure
+ * @sc: the sc structure
  *
  * Returns: errno
  */
@@ -940,8 +938,8 @@ static int gfs2_statfs_i(struct gfs2_sbd *sdp, struct gfs2_statfs_change_host *s
 
 /**
  * gfs2_statfs - Gather and return stats about the filesystem
- * @sb: The superblock
- * @statfsbuf: The buffer
+ * @dentry: The name of the link
+ * @buf: The buffer
  *
  * Returns: 0 on success or error code
  */
@@ -1272,6 +1270,7 @@ static bool gfs2_upgrade_iopen_glock(struct inode *inode)
 /**
  * evict_should_delete - determine whether the inode is eligible for deletion
  * @inode: The inode to evict
+ * @gh: the holder structure
  *
  * This function determines whether the evicted inode is eligible to be deleted
  * and locks the inode glock.
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 17/31] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (15 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 16/31] fs: gfs2: super: Fix kernel-doc issues where feasible demote " Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 18/31] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header Lee Jones
  2021-04-19  5:09 ` [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Tyler Hicks
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/util.c:52: warning: Function parameter or member 'verbose' not described in 'check_journal_clean'
 fs/gfs2/util.c:372: warning: Function parameter or member 'sdp' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:372: warning: Function parameter or member 'assertion' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:372: warning: Function parameter or member 'function' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:372: warning: Function parameter or member 'file' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:372: warning: Function parameter or member 'line' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:372: warning: Function parameter or member 'delayed' not described in 'gfs2_assert_withdraw_i'
 fs/gfs2/util.c:401: warning: Function parameter or member 'sdp' not described in 'gfs2_assert_warn_i'
 fs/gfs2/util.c:401: warning: Function parameter or member 'assertion' not described in 'gfs2_assert_warn_i'
 fs/gfs2/util.c:401: warning: Function parameter or member 'function' not described in 'gfs2_assert_warn_i'
 fs/gfs2/util.c:401: warning: Function parameter or member 'file' not described in 'gfs2_assert_warn_i'
 fs/gfs2/util.c:401: warning: Function parameter or member 'line' not described in 'gfs2_assert_warn_i'
 fs/gfs2/util.c:431: warning: Function parameter or member 'sdp' not described in 'gfs2_consist_i'
 fs/gfs2/util.c:431: warning: Function parameter or member 'function' not described in 'gfs2_consist_i'
 fs/gfs2/util.c:431: warning: Function parameter or member 'file' not described in 'gfs2_consist_i'
 fs/gfs2/util.c:431: warning: Function parameter or member 'line' not described in 'gfs2_consist_i'
 fs/gfs2/util.c:444: warning: Function parameter or member 'ip' not described in 'gfs2_consist_inode_i'
 fs/gfs2/util.c:444: warning: Function parameter or member 'function' not described in 'gfs2_consist_inode_i'
 fs/gfs2/util.c:444: warning: Function parameter or member 'file' not described in 'gfs2_consist_inode_i'
 fs/gfs2/util.c:444: warning: Function parameter or member 'line' not described in 'gfs2_consist_inode_i'
 fs/gfs2/util.c:463: warning: Function parameter or member 'rgd' not described in 'gfs2_consist_rgrpd_i'
 fs/gfs2/util.c:463: warning: Function parameter or member 'function' not described in 'gfs2_consist_rgrpd_i'
 fs/gfs2/util.c:463: warning: Function parameter or member 'file' not described in 'gfs2_consist_rgrpd_i'
 fs/gfs2/util.c:463: warning: Function parameter or member 'line' not described in 'gfs2_consist_rgrpd_i'
 fs/gfs2/util.c:487: warning: Function parameter or member 'sdp' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:487: warning: Function parameter or member 'bh' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:487: warning: Function parameter or member 'type' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:487: warning: Function parameter or member 'function' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:487: warning: Function parameter or member 'file' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:487: warning: Function parameter or member 'line' not described in 'gfs2_meta_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'sdp' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'bh' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'type' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 't' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'function' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'file' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:509: warning: Function parameter or member 'line' not described in 'gfs2_metatype_check_ii'
 fs/gfs2/util.c:530: warning: Function parameter or member 'sdp' not described in 'gfs2_io_error_i'
 fs/gfs2/util.c:530: warning: Function parameter or member 'function' not described in 'gfs2_io_error_i'
 fs/gfs2/util.c:530: warning: Function parameter or member 'file' not described in 'gfs2_io_error_i'
 fs/gfs2/util.c:530: warning: Function parameter or member 'line' not described in 'gfs2_io_error_i'
 fs/gfs2/util.c:546: warning: Function parameter or member 'sdp' not described in 'gfs2_io_error_bh_i'
 fs/gfs2/util.c:546: warning: Function parameter or member 'bh' not described in 'gfs2_io_error_bh_i'
 fs/gfs2/util.c:546: warning: Function parameter or member 'function' not described in 'gfs2_io_error_bh_i'
 fs/gfs2/util.c:546: warning: Function parameter or member 'file' not described in 'gfs2_io_error_bh_i'
 fs/gfs2/util.c:546: warning: Function parameter or member 'line' not described in 'gfs2_io_error_bh_i'

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

diff --git a/fs/gfs2/util.c b/fs/gfs2/util.c
index 4f034b87b4276..3e08027a6c81b 100644
--- a/fs/gfs2/util.c
+++ b/fs/gfs2/util.c
@@ -44,6 +44,7 @@ void gfs2_assert_i(struct gfs2_sbd *sdp)
  * check_journal_clean - Make sure a journal is clean for a spectator mount
  * @sdp: The GFS2 superblock
  * @jd: The journal descriptor
+ * @verbose: Show more prints in the log
  *
  * Returns: 0 if the journal is clean or locked, else an error
  */
@@ -362,7 +363,7 @@ int gfs2_withdraw(struct gfs2_sbd *sdp)
 	return -1;
 }
 
-/**
+/*
  * gfs2_assert_withdraw_i - Cause the machine to withdraw if @assertion is false
  */
 
@@ -392,7 +393,7 @@ void gfs2_assert_withdraw_i(struct gfs2_sbd *sdp, char *assertion,
 	dump_stack();
 }
 
-/**
+/*
  * gfs2_assert_warn_i - Print a message to the console if @assertion is false
  */
 
@@ -422,7 +423,7 @@ void gfs2_assert_warn_i(struct gfs2_sbd *sdp, char *assertion,
 	sdp->sd_last_warning = jiffies;
 }
 
-/**
+/*
  * gfs2_consist_i - Flag a filesystem consistency error and withdraw
  */
 
@@ -435,7 +436,7 @@ void gfs2_consist_i(struct gfs2_sbd *sdp, const char *function,
 	gfs2_withdraw(sdp);
 }
 
-/**
+/*
  * gfs2_consist_inode_i - Flag an inode consistency error and withdraw
  */
 
@@ -454,7 +455,7 @@ void gfs2_consist_inode_i(struct gfs2_inode *ip,
 	gfs2_withdraw(sdp);
 }
 
-/**
+/*
  * gfs2_consist_rgrpd_i - Flag a RG consistency error and withdraw
  */
 
@@ -475,7 +476,7 @@ void gfs2_consist_rgrpd_i(struct gfs2_rgrpd *rgd,
 	gfs2_withdraw(sdp);
 }
 
-/**
+/*
  * gfs2_meta_check_ii - Flag a magic number consistency error and withdraw
  * Returns: -1 if this call withdrew the machine,
  *          -2 if it was already withdrawn
@@ -497,7 +498,7 @@ int gfs2_meta_check_ii(struct gfs2_sbd *sdp, struct buffer_head *bh,
 	return (me) ? -1 : -2;
 }
 
-/**
+/*
  * gfs2_metatype_check_ii - Flag a metadata type consistency error and withdraw
  * Returns: -1 if this call withdrew the machine,
  *          -2 if it was already withdrawn
@@ -519,7 +520,7 @@ int gfs2_metatype_check_ii(struct gfs2_sbd *sdp, struct buffer_head *bh,
 	return (me) ? -1 : -2;
 }
 
-/**
+/*
  * gfs2_io_error_i - Flag an I/O error and withdraw
  * Returns: -1 if this call withdrew the machine,
  *          0 if it was already withdrawn
@@ -535,7 +536,7 @@ int gfs2_io_error_i(struct gfs2_sbd *sdp, const char *function, char *file,
 	return gfs2_withdraw(sdp);
 }
 
-/**
+/*
  * gfs2_io_error_bh_i - Flag a buffer I/O error
  * @withdraw: withdraw the filesystem
  */
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 18/31] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (16 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 17/31] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses Lee Jones
@ 2021-03-30 16:44 ` Lee Jones
  2021-04-19  5:09 ` [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Tyler Hicks
  18 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-03-30 16:44 UTC (permalink / raw)
  To: cluster-devel.redhat.com

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

 fs/gfs2/lock_dlm.c:48: warning: Function parameter or member 's' not described in 'gfs2_update_stats'
 fs/gfs2/lock_dlm.c:48: warning: Function parameter or member 'index' not described in 'gfs2_update_stats'
 fs/gfs2/lock_dlm.c:48: warning: Excess function parameter 'mv' description in 'gfs2_update_stats'

Cc: Bob Peterson <rpeterso@redhat.com>
Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: cluster-devel at redhat.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 fs/gfs2/lock_dlm.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/fs/gfs2/lock_dlm.c b/fs/gfs2/lock_dlm.c
index 153272f82984b..4afd98c91e73e 100644
--- a/fs/gfs2/lock_dlm.c
+++ b/fs/gfs2/lock_dlm.c
@@ -22,9 +22,8 @@
 #include "sys.h"
 #include "trace_gfs2.h"
 
-/**
+/*
  * gfs2_update_stats - Update time based stats
- * @mv: Pointer to mean/variance structure to update
  * @sample: New data to include
  *
  * @delta is the difference between the current rtt sample and the
-- 
2.27.0



^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS
  2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
                   ` (17 preceding siblings ...)
  2021-03-30 16:44 ` [Cluster-devel] [PATCH 18/31] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header Lee Jones
@ 2021-04-19  5:09 ` Tyler Hicks
  2021-04-19  7:26   ` Lee Jones
  18 siblings, 1 reply; 21+ messages in thread
From: Tyler Hicks @ 2021-04-19  5:09 UTC (permalink / raw)
  To: cluster-devel.redhat.com

On 2021-03-30 17:44:27, Lee Jones wrote:
> This set is part of a larger effort attempting to clean-up W=1
> kernel builds, which are currently overwhelmingly riddled with
> niggly little warnings.
> 
> There is more to do in filesystems.  Another set will follow.
> 
> Lee Jones (31):
...
>   fs: ecryptfs: read_write: File headers do not make good candidates for
>     kernel-doc
>   fs: ecryptfs: debug: Demote a couple of kernel-doc abuses
>   fs: ecryptfs: dentry: File headers are not good candidates for
>     kernel-doc
>   fs: ecryptfs: kthread: Demote file header and provide description for
>     'cred'
>   fs: ecryptfs: file: Demote kernel-doc abuses
>   fs: ecryptfs: super: Fix formatting, naming and kernel-doc abuses
>   fs: ecryptfs: messaging: Add missing param descriptions and demote
>     abuses
>   fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc
>     headers
>   fs: ecryptfs: miscdev: File headers are not good kernel-doc candidates
>   fs: ecryptfs: crypto: Supply some missing param descriptions and
>     demote abuses
>   fs: ecryptfs: mmap: Help out one function header and demote other
>     abuses
>   fs: ecryptfs: inode: Help out nearly-there header and demote
>     non-conformant ones
>   fs: ecryptfs: keystore: Fix some kernel-doc issues and demote
>     non-conformant headers

I've applied the eCryptfs fixes to the next branch of
tyhicks/ecryptfs.git. Thanks for the clean-up!

Tyler



^ permalink raw reply	[flat|nested] 21+ messages in thread

* [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS
  2021-04-19  5:09 ` [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Tyler Hicks
@ 2021-04-19  7:26   ` Lee Jones
  0 siblings, 0 replies; 21+ messages in thread
From: Lee Jones @ 2021-04-19  7:26 UTC (permalink / raw)
  To: cluster-devel.redhat.com

On Mon, 19 Apr 2021, Tyler Hicks wrote:

> On 2021-03-30 17:44:27, Lee Jones wrote:
> > This set is part of a larger effort attempting to clean-up W=1
> > kernel builds, which are currently overwhelmingly riddled with
> > niggly little warnings.
> > 
> > There is more to do in filesystems.  Another set will follow.
> > 
> > Lee Jones (31):
> ...
> >   fs: ecryptfs: read_write: File headers do not make good candidates for
> >     kernel-doc
> >   fs: ecryptfs: debug: Demote a couple of kernel-doc abuses
> >   fs: ecryptfs: dentry: File headers are not good candidates for
> >     kernel-doc
> >   fs: ecryptfs: kthread: Demote file header and provide description for
> >     'cred'
> >   fs: ecryptfs: file: Demote kernel-doc abuses
> >   fs: ecryptfs: super: Fix formatting, naming and kernel-doc abuses
> >   fs: ecryptfs: messaging: Add missing param descriptions and demote
> >     abuses
> >   fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc
> >     headers
> >   fs: ecryptfs: miscdev: File headers are not good kernel-doc candidates
> >   fs: ecryptfs: crypto: Supply some missing param descriptions and
> >     demote abuses
> >   fs: ecryptfs: mmap: Help out one function header and demote other
> >     abuses
> >   fs: ecryptfs: inode: Help out nearly-there header and demote
> >     non-conformant ones
> >   fs: ecryptfs: keystore: Fix some kernel-doc issues and demote
> >     non-conformant headers
> 
> I've applied the eCryptfs fixes to the next branch of
> tyhicks/ecryptfs.git. Thanks for the clean-up!

Thanks Tyler, much appreciated.

-- 
Lee Jones [???]
Senior Technical Lead - Developer Services
Linaro.org ? Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog



^ permalink raw reply	[flat|nested] 21+ messages in thread

end of thread, other threads:[~2021-04-19  7:26 UTC | newest]

Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-03-30 16:44 [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 02/31] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 03/31] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 04/31] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 06/31] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 07/31] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 08/31] fs: gfs2: aops: Fix a little potential doc-rot Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 09/31] fs: gfs2: meta_io: Add missing description for 'rahead' param Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 10/31] fs: gfs2: inode: Fix worthy function headers demote others Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 11/31] fs: gfs2: file: Strip out superfluous param description and demote kernel-doc abuse Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 12/31] fs: gfs2: ops_fstype: Fix a little doc-rot Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 13/31] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad' Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 14/31] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 15/31] fs: gfs2: recovery: Provide missing param descriptions and remove one other Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 16/31] fs: gfs2: super: Fix kernel-doc issues where feasible demote " Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 17/31] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses Lee Jones
2021-03-30 16:44 ` [Cluster-devel] [PATCH 18/31] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header Lee Jones
2021-04-19  5:09 ` [Cluster-devel] [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Tyler Hicks
2021-04-19  7:26   ` Lee Jones

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).