Skip to contentSkip to conversation

ubifs: Fix some kernel-doc warnings for ubifs

PATCH Applied Wang Hai 2 participants 6 messages Sep 14, 2020 – Sep 17, 2020

Subsystems (2)
lore
Share & tools
lore

Wang Hai

author
#0 lore raw

cover ubifs: Fix some kernel-doc warnings for ubifs

In the ubifs module, there are some kernel-doc warnings, this series of patches can fix these warnings.

Wang Hai (4):
ubifs: Fix 'hash' kernel-doc warning in auth.c
ubifs: Fix some kernel-doc warnings in gc.c
ubifs: Fix some kernel-doc warnings in replay.c
ubifs: Fix some kernel-doc warnings in tnc.c

 fs/ubifs/auth.c   | 2 +-
 fs/ubifs/gc.c     | 4 ----
 fs/ubifs/replay.c | 2 --
 fs/ubifs/tnc.c    | 3 +--
 4 files changed, 2 insertions(+), 9 deletions(-)
Signature · 6 lines
2.17.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
author
#1 lore raw

PATCH 1/4 ubifs: Fix 'hash' kernel-doc warning in auth.c

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

fs/ubifs/auth.c:66: warning: Excess function parameter 'hash' description in 'ubifs_prepare_auth_node'

Rename hash to inhash.

---
 fs/ubifs/auth.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/ubifs/auth.c +1 -1
index cc5c0abfd536..b93b3cd10bfd 100644
@@ -54,7 +54,7 @@ static int ubifs_hash_calc_hmac(const struct ubifs_info *c, const u8 *hash,
  * ubifs_prepare_auth_node - Prepare an authentication node
  * @c: UBIFS file-system description object
  * @node: the node to calculate a hash for
- * @hash: input hash of previous nodes
+ * @inhash: input hash of previous nodes
  *
  * This function prepares an authentication node for writing onto flash.
  * It creates a HMAC from the given input hash and writes it to the node.
Signature · 6 lines
2.17.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
author
#2 lore raw

PATCH 2/4 ubifs: Fix some kernel-doc warnings in gc.c

In reply to Wang Hai

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

fs/ubifs/gc.c:70: warning: Excess function parameter 'buf' description in 'switch_gc_head' fs/ubifs/gc.c:70: warning: Excess function parameter 'len' description in 'switch_gc_head' fs/ubifs/gc.c:70: warning: Excess function parameter 'lnum' description in 'switch_gc_head' fs/ubifs/gc.c:70: warning: Excess function parameter 'offs' description in 'switch_gc_head'

They're not in use. Remove them.

---
 fs/ubifs/gc.c | 4 ----
 1 file changed, 4 deletions(-)
fs/ubifs/gc.c +0 -4
index 62cb3db44e6e..a4aaeea63893 100644
@@ -57,10 +57,6 @@
 /**
  * switch_gc_head - switch the garbage collection journal head.
  * @c: UBIFS file-system description object
- * @buf: buffer to write
- * @len: length of the buffer to write
- * @lnum: LEB number written is returned here
- * @offs: offset written is returned here
  *
  * This function switch the GC head to the next LEB which is reserved in
  * @c->gc_lnum. Returns %0 in case of success, %-EAGAIN if commit is required,
Signature · 6 lines
2.17.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
author
#3 lore raw

PATCH 3/4 ubifs: Fix some kernel-doc warnings in replay.c

In reply to Wang Hai

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

fs/ubifs/replay.c:942: warning: Excess function parameter 'ref_lnum' description in 'validate_ref' fs/ubifs/replay.c:942: warning: Excess function parameter 'ref_offs' description in 'validate_ref'

They're not in use. Remove them.

---
 fs/ubifs/replay.c | 2 --
 1 file changed, 2 deletions(-)
fs/ubifs/replay.c +0 -2
index b69ffac7e415..2f8d8f4f411a 100644
@@ -931,8 +931,6 @@ static int add_replay_bud(struct ubifs_info *c, int lnum, int offs, int jhead,
  * validate_ref - validate a reference node.
  * @c: UBIFS file-system description object
  * @ref: the reference node to validate
- * @ref_lnum: LEB number of the reference node
- * @ref_offs: reference node offset
  *
  * This function returns %1 if a bud reference already exists for the LEB. %0 is
  * returned if the reference node is new, otherwise %-EINVAL is returned if
Signature · 6 lines
2.17.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
author
#4 lore raw

PATCH 4/4 ubifs: Fix some kernel-doc warnings in tnc.c

In reply to Wang Hai

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

fs/ubifs/tnc.c:3479: warning: Excess function parameter 'inum' description in 'dbg_check_inode_size' fs/ubifs/tnc.c:366: warning: Excess function parameter 'node' description in 'lnc_free'

@inum in 'dbg_check_inode_size' should be @inode, fix it. @node in 'lnc_free' is not in use, Remove it.

---
 fs/ubifs/tnc.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
fs/ubifs/tnc.c +1 -2
index f609f6cdde70..de21625804a9 100644
@@ -360,7 +360,6 @@ static int lnc_add_directly(struct ubifs_info *c, struct ubifs_zbranch *zbr,
 /**
  * lnc_free - remove a leaf node from the leaf node cache.
  * @zbr: zbranch of leaf node
- * @node: leaf node
  */
 static void lnc_free(struct ubifs_zbranch *zbr)
 {
@@ -3466,7 +3465,7 @@ int ubifs_dirty_idx_node(struct ubifs_info *c, union ubifs_key *key, int level,
 /**
  * dbg_check_inode_size - check if inode size is correct.
  * @c: UBIFS file-system description object
- * @inum: inode number
+ * @inode: inode to check
  * @size: inode size
  *
  * This function makes sure that the inode size (@size) is correct and it does
Signature · 6 lines
2.17.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
#5 lore raw
In reply to Wang Hai
Quoted 9 lines · Wang Hai

In the ubifs module, there are some kernel-doc warnings, this series of patches can fix these warnings.

Wang Hai (4):
ubifs: Fix 'hash' kernel-doc warning in auth.c
ubifs: Fix some kernel-doc warnings in gc.c
ubifs: Fix some kernel-doc warnings in replay.c
ubifs: Fix some kernel-doc warnings in tnc.c

Applied to next, thanks!

Signature · 2 lines
Thanks,
//richard