Skip to contentSkip to conversation

btrfs: add missing function name in btrfs_log_new_name() kernel-doc comment

PATCH New Bagas Sanjaya 1 participant 1 message May 26, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 btrfs: add missing function name in btrfs_log_new_name() kernel-doc comment

kernel test robot reported kernel-doc warning:

Quoted 1 line
Quoted 1 line

fs/btrfs/tree-log.c:6792: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

* Update the log after adding a new name for an inode.

This has side-effect warning when invoking kernel-doc script directly:

fs/btrfs/tree-log.c:6957: warning: missing initial short description on line:
* Update the log after adding a new name for an inode.

These warnings above are caused by missing function name in the kernel-doc comment of btrfs_log_new_name().

Fix these by adding the function name into short description on the comment block.

Fixes d5f5bd546552a9 ("btrfs: pass the dentry to btrfs_log_new_name() instead of the inode")
Cc Filipe Manana <[email protected]>
Cc Chris Mason <[email protected]>
Cc Josef Bacik <[email protected]>
Cc David Sterba <[email protected]>
---
 fs/btrfs/tree-log.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/tree-log.c +1 -1
index 370388fadf960a..d25cbe61fdb669 100644
@@ -6954,7 +6954,7 @@ void btrfs_record_snapshot_destroy(struct btrfs_trans_handle *trans,
 }
 
 /**
- * Update the log after adding a new name for an inode.
+ * btrfs_log_new_name() - Update the log after adding a new name for an inode.
  *
  * @trans:              Transaction handle.
  * @old_dentry:         The dentry associated with the old name and the old

base-commit: babf0bb978e3c9fce6c4eba6b744c8754fd43d8e

Signature · 1 line
An old man doll... just what I always wanted! - Clara