Re: [kdave-btrfs-devel:misc-next 149/153] fs/btrfs/tree-log.c:6755: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[David Sterba]

On Wed, Jan 26, 2022 at 10:31:43AM +0000, Filipe Manana wrote:
> 
> 
> On 25/01/22 23:12, kernel test robot wrote:
> > tree:   https://github.com/kdave/btrfs-devel.git misc-next
> > head:   8e5d6a5c062f370d4d0b2dace7e95ab40c6ce3dd
> > commit: 6bfc5d45946acd8286fb026137f20ee8747a50f1 [149/153] btrfs: pass the dentry to btrfs_log_new_name() instead of the inode
> > config: nds32-allyesconfig (https://download.01.org/0day-ci/archive/20220126/202201260759.edlA9lHT-lkp@xxxxxxxxx/config)
> > compiler: nds32le-linux-gcc (GCC) 11.2.0
> > reproduce (this is a W=1 build):
> >         wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
> >         chmod +x ~/bin/make.cross
> >         # https://github.com/kdave/btrfs-devel/commit/6bfc5d45946acd8286fb026137f20ee8747a50f1
> >         git remote add kdave-btrfs-devel https://github.com/kdave/btrfs-devel.git
> >         git fetch --no-tags kdave-btrfs-devel misc-next
> >         git checkout 6bfc5d45946acd8286fb026137f20ee8747a50f1
> >         # save the config file to linux build tree
> >         mkdir build_dir
> >         COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-11.2.0 make.cross O=build_dir ARCH=nds32 SHELL=/bin/bash fs/btrfs/
> > 
> > If you fix the issue, kindly add following tag as appropriate
> > Reported-by: kernel test robot <lkp@xxxxxxxxx>
> > 
> > All warnings (new ones prefixed by >>):
> > 
> >>> fs/btrfs/tree-log.c:6755: 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.
> > 
> > 
> > vim +6755 fs/btrfs/tree-log.c
> > 
> >   6753	
> >   6754	/**
> >> 6755	 * Update the log after adding a new name for an inode.
> 
> The patch I submitted did not add the "/**":
> 
> https://lore.kernel.org/linux-btrfs/1f0d5aaf498afa64ef3582cb9d9d24bc5f888ab2.1642676248.git.fdmanana@xxxxxxxx/T/#u
> 
> However I see that David's misc-next branch, the patch adds that:
> 
> https://github.com/kdave/btrfs-devel/commit/6bfc5d45946acd8286fb026137f20ee8747a50f1
> 
> David, did you edit the patch? Why?

Yes I did that, because you've added the parameter descriptions and with
the /** we can ask the kdoc script to verify that they're in order as
in the function and that the list is complete. That's all what we need
from kdoc but it mandates a particular format on the first line that
does not make sense for internal helpers.