From: Randy Dunlap <rdunlap@infradead.org>
To: linux-fsdevel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Luis de Bethencourt <luisbg@kernel.org>,
Salah Triki <salah.triki@gmail.com>
Subject: [PATCH] befs: fix datastream.c kernel-doc warnings
Date: Tue, 5 Dec 2023 18:34:17 -0800 [thread overview]
Message-ID: <20231206023417.30323-1-rdunlap@infradead.org> (raw)
Fix kernel-doc warnings found when using "W=1".
datastream.c:51: warning: No description found for return value of 'befs_read_datastream'
datastream.c:97: warning: No description found for return value of 'befs_fblock2brun'
datastream.c:132: warning: expecting prototype for befs_read_lsmylink(). Prototype was for befs_read_lsymlink() instead
datastream.c:132: warning: No description found for return value of 'befs_read_lsymlink'
datastream.c:173: warning: No description found for return value of 'befs_count_blocks'
datastream.c:253: warning: No description found for return value of 'befs_find_brun_direct'
datastream.c:309: warning: No description found for return value of 'befs_find_brun_indirect'
datastream.c:418: warning: No description found for return value of 'befs_find_brun_dblindirect'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Luis de Bethencourt <luisbg@kernel.org>
Cc: Salah Triki <salah.triki@gmail.com>
---
fs/befs/datastream.c | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff -- a/fs/befs/datastream.c b/fs/befs/datastream.c
--- a/fs/befs/datastream.c
+++ b/fs/befs/datastream.c
@@ -42,7 +42,7 @@ static int befs_find_brun_dblindirect(st
* @pos: start of data
* @off: offset of data in buffer_head->b_data
*
- * Returns pointer to buffer_head containing data starting with offset @off,
+ * Returns: pointer to buffer_head containing data starting with offset @off,
* if you don't need to know offset just set @off = NULL.
*/
struct buffer_head *
@@ -86,7 +86,7 @@ befs_read_datastream(struct super_block
* Takes a file position and gives back a brun who's starting block
* is block number fblock of the file.
*
- * Returns BEFS_OK or BEFS_ERR.
+ * Returns: BEFS_OK or BEFS_ERR.
*
* Calls specialized functions for each of the three possible
* datastream regions.
@@ -118,13 +118,13 @@ befs_fblock2brun(struct super_block *sb,
}
/**
- * befs_read_lsmylink - read long symlink from datastream.
+ * befs_read_lsymlink - read long symlink from datastream.
* @sb: Filesystem superblock
* @ds: Datastream to read from
* @buff: Buffer in which to place long symlink data
* @len: Length of the long symlink in bytes
*
- * Returns the number of bytes read
+ * Returns: the number of bytes read
*/
size_t
befs_read_lsymlink(struct super_block *sb, const befs_data_stream *ds,
@@ -166,6 +166,8 @@ befs_read_lsymlink(struct super_block *s
* inode occupies on the filesystem, counting both regular file
* data and filesystem metadata (and eventually attribute data
* when we support attributes)
+ *
+ * Returns: count of blocks used by the file
*/
befs_blocknr_t
@@ -229,8 +231,7 @@ befs_count_blocks(struct super_block *sb
* in the file represented by the datastream data, if that
* blockno is in the direct region of the datastream.
*
- * Return value is BEFS_OK if the blockrun is found, BEFS_ERR
- * otherwise.
+ * Returns: BEFS_OK if the blockrun is found, BEFS_ERR otherwise.
*
* Algorithm:
* Linear search. Checks each element of array[] to see if it
@@ -290,8 +291,7 @@ befs_find_brun_direct(struct super_block
* in the file represented by the datastream data, if that
* blockno is in the indirect region of the datastream.
*
- * Return value is BEFS_OK if the blockrun is found, BEFS_ERR
- * otherwise.
+ * Returns: BEFS_OK if the blockrun is found, BEFS_ERR otherwise.
*
* Algorithm:
* For each block in the indirect run of the datastream, read
@@ -381,8 +381,7 @@ befs_find_brun_indirect(struct super_blo
* in the file represented by the datastream data, if that
* blockno is in the double-indirect region of the datastream.
*
- * Return value is BEFS_OK if the blockrun is found, BEFS_ERR
- * otherwise.
+ * Returns: BEFS_OK if the blockrun is found, BEFS_ERR otherwise.
*
* Algorithm:
* The block runs in the double-indirect region are different.
reply other threads:[~2023-12-06 2:34 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20231206023417.30323-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=luisbg@kernel.org \
--cc=salah.triki@gmail.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).