[PATCH] cifs: fix incorrect kernel doc comments Correct kernel-doc comments pointed out by the automated kernel test robot - see attached patch. Reported-by: kernel test robot On Mon, Sep 13, 2021 at 4:13 AM kernel test robot wrote: > > Hi Steve, > > First bad commit (maybe != root cause): > > tree: git://git.samba.org/sfrench/cifs-2.6.git for-next > head: bba805a46c91e7a8a1d04704e5409f890acf8b66 > commit: bba805a46c91e7a8a1d04704e5409f890acf8b66 [1/1] cifs: rename fs/cifs directory to fs/smbfs > config: hexagon-randconfig-r045-20210913 (attached as .config) > compiler: clang version 14.0.0 (https://github.com/llvm/llvm-project 261cbe98c38f8c1ee1a482fe76511110e790f58a) > 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 > git remote add cifs git://git.samba.org/sfrench/cifs-2.6.git > git fetch --no-tags cifs for-next > git checkout bba805a46c91e7a8a1d04704e5409f890acf8b66 > # save the attached .config to linux build tree > COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=hexagon > > If you fix the issue, kindly add following tag as appropriate > Reported-by: kernel test robot > > All warnings (new ones prefixed by >>): > > >> fs/smbfs/ioctl.c:324:10: warning: variable 'caps' set but not used [-Wunused-but-set-variable] > __u64 caps; > ^ > 1 warning generated. > -- > >> fs/smbfs/connect.c:1093: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Returns true if srcaddr isn't specified and rhs isn't specified, or > fs/smbfs/connect.c:1558: warning: Function parameter or member 'ses' not described in 'cifs_setup_ipc' > fs/smbfs/connect.c:1558: warning: Function parameter or member 'ctx' not described in 'cifs_setup_ipc' > fs/smbfs/connect.c:1618: warning: Function parameter or member 'ses' not described in 'cifs_free_ipc' > fs/smbfs/connect.c:1864: warning: Function parameter or member 'server' not described in 'cifs_get_smb_ses' > fs/smbfs/connect.c:1864: warning: Function parameter or member 'ctx' not described in 'cifs_get_smb_ses' > fs/smbfs/connect.c:2087: warning: Function parameter or member 'ses' not described in 'cifs_get_tcon' > fs/smbfs/connect.c:2087: warning: Function parameter or member 'ctx' not described in 'cifs_get_tcon' > fs/smbfs/connect.c:3046: warning: Function parameter or member 'xid' not described in 'expand_dfs_referral' > fs/smbfs/connect.c:3046: warning: Function parameter or member 'ses' not described in 'expand_dfs_referral' > fs/smbfs/connect.c:3046: warning: Function parameter or member 'ctx' not described in 'expand_dfs_referral' > fs/smbfs/connect.c:3046: warning: Function parameter or member 'cifs_sb' not described in 'expand_dfs_referral' > fs/smbfs/connect.c:3046: warning: Function parameter or member 'ref_path' not described in 'expand_dfs_referral' > > > vim +/caps +324 fs/smbfs/ioctl.c > > 7ba3d1cdb7988c fs/cifs/ioctl.c Steve French 2021-05-02 312 > f9ddcca4cf7d95 fs/cifs/ioctl.c Steve French 2008-05-15 313 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg) > ^1da177e4c3f41 fs/cifs/ioctl.c Linus Torvalds 2005-04-16 314 { > 496ad9aa8ef448 fs/cifs/ioctl.c Al Viro 2013-01-23 315 struct inode *inode = file_inode(filep); > 7e7db86c7e1088 fs/cifs/ioctl.c Steve French 2019-09-19 316 struct smb3_key_debug_info pkey_inf; > ^1da177e4c3f41 fs/cifs/ioctl.c Linus Torvalds 2005-04-16 317 int rc = -ENOTTY; /* strange error - but the precedent */ > 6d5786a34d98bf fs/cifs/ioctl.c Pavel Shilovsky 2012-06-20 318 unsigned int xid; > ba00ba64cf0895 fs/cifs/ioctl.c Jeff Layton 2010-09-20 319 struct cifsFileInfo *pSMBFile = filep->private_data; > 96daf2b09178d8 fs/cifs/ioctl.c Steve French 2011-05-27 320 struct cifs_tcon *tcon; > a77592a70081ed fs/cifs/ioctl.c Ronnie Sahlberg 2020-07-09 321 struct tcon_link *tlink; > d26c2ddd335696 fs/cifs/ioctl.c Steve French 2020-02-06 322 struct cifs_sb_info *cifs_sb; > f654bac2227adc fs/cifs/ioctl.c Steve French 2005-04-28 323 __u64 ExtAttrBits = 0; > 618763958b2291 fs/cifs/ioctl.c Jeff Layton 2010-11-08 @324 __u64 caps; > > :::::: The code at line 324 was first introduced by commit > :::::: 618763958b2291a09057dbfa553da6ded93dcfad cifs: make cifs_ioctl handle NULL filp->private_data correctly > > :::::: TO: Jeff Layton > :::::: CC: Steve French > > --- > 0-DAY CI Kernel Test Service, Intel Corporation > https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org -- Thanks, Steve