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 01/18] fs: gfs2: dir: Finish off mostly complete headers demote others
Date: Fri, 26 Mar 2021 09:11:34 +0000 [thread overview]
Message-ID: <20210326091151.311647-2-lee.jones@linaro.org> (raw)
In-Reply-To: <20210326091151.311647-1-lee.jones@linaro.org>
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@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
next prev parent reply other threads:[~2021-03-26 9:12 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-26 9:11 [PATCH 00/18] Rid W=1 warnings from GFS2 Lee Jones
2021-03-26 9:11 ` Lee Jones [this message]
2021-03-26 9:11 ` [PATCH 02/18] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones Lee Jones
2021-03-26 9:11 ` [PATCH 03/18] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others Lee Jones
2021-03-26 9:11 ` [PATCH 04/18] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others Lee Jones
2021-03-26 9:11 ` [PATCH 05/18] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers Lee Jones
2021-03-26 9:11 ` [PATCH 06/18] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others Lee Jones
2021-03-26 9:11 ` [PATCH 07/18] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones Lee Jones
2021-03-26 9:11 ` [PATCH 08/18] fs: gfs2: aops: Fix a little potential doc-rot Lee Jones
2021-03-26 9:11 ` [PATCH 09/18] fs: gfs2: meta_io: Add missing description for 'rahead' param Lee Jones
2021-03-26 9:11 ` [PATCH 10/18] fs: gfs2: inode: Fix worthy function headers demote others Lee Jones
2021-03-26 9:11 ` [PATCH 11/18] fs: gfs2: file: Strip out superflouous param description and demote kernel-doc abuse Lee Jones
2021-03-26 9:11 ` [PATCH 12/18] fs: gfs2: ops_fstype: Fix a little doc-rot Lee Jones
2021-03-26 9:11 ` [PATCH 13/18] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad' Lee Jones
2021-03-26 9:11 ` [PATCH 14/18] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours Lee Jones
2021-03-26 9:11 ` [PATCH 15/18] fs: gfs2: recovery: Provide missing param descriptions and remove one other Lee Jones
2021-03-26 9:11 ` [PATCH 16/18] fs: gfs2: super: Fix kernel-doc issues where feasible demote " Lee Jones
2021-03-26 9:11 ` [PATCH 17/18] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses Lee Jones
2021-03-26 9:11 ` [PATCH 18/18] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header Lee Jones
2021-04-06 9:11 ` [PATCH 00/18] Rid W=1 warnings from GFS2 Lee Jones
2021-04-06 11:44 ` Bob Peterson
2021-04-06 11:54 ` Lee Jones
2021-04-09 20:35 ` Andreas Gruenbacher
2021-04-12 7:37 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210326091151.311647-2-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=agruenba@redhat.com \
--cc=cluster-devel@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=rpeterso@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).