kernel test robot reported kernel-doc warning:
>> 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.
Link: https://lore.kernel.org/linux-doc/202205260024.TLEp6Pj2-lkp@xxxxxxxxx/
Fixes: d5f5bd546552a9 ("btrfs: pass the dentry to btrfs_log_new_name() instead of the inode")
Cc: Filipe Manana <fdmanana@xxxxxxxx>
Cc: Chris Mason <clm@xxxxxx>
Cc: Josef Bacik <josef@xxxxxxxxxxxxxx>
Cc: David Sterba <dsterba@xxxxxxxx>
Cc: linux-btrfs@xxxxxxxxxxxxxxx
Cc: linux-kernel@xxxxxxxxxxxxxxx
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
fs/btrfs/tree-log.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/fs/btrfs/tree-log.c b/fs/btrfs/tree-log.c
index 370388fadf960a..d25cbe61fdb669 100644
--- a/fs/btrfs/tree-log.c
+++ b/fs/btrfs/tree-log.c
@@ -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
--
An old man doll... just what I always wanted! - Clara
