Re: [PATCH] Check all .c files for bad kernel-doc comments

From: kbuild test robot
Date: Sun Oct 29 2017 - 16:23:19 EST

Next message: Julio Candela CPat: "[no subject]"
Previous message: Steven Rostedt: "Re: [GIT PULL] tracing/samples: Fix creation and deletion of simple_thread_fn creation"
In reply to: Matthew Wilcox: "[PATCH] Check all .c files for bad kernel-doc comments"
Next in thread: kbuild test robot: "Re: [PATCH] Check all .c files for bad kernel-doc comments"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

Hi Matthew,

I love your patch! Perhaps something to improve:

[auto build test WARNING on linus/master]
[also build test WARNING on v4.14-rc6 next-20171018]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url: https://github.com/0day-ci/linux/commits/Matthew-Wilcox/Check-all-c-files-for-bad-kernel-doc-comments/20171030-033926
config: i386-tinyconfig (attached as .config)
compiler: gcc-6 (Debian 6.2.0-3) 6.2.0 20160901
reproduce:
# save the attached .config to linux build tree
make ARCH=i386

All warnings (new ones prefixed by >>):

>> fs//attr.c:114: warning: Excess function parameter 'Returns' description in 'inode_newsize_ok'
>> fs//attr.c:205: warning: No description found for parameter 'attr'
>> fs//attr.c:205: warning: Excess function parameter 'iattr' description in 'notify_change'
--
>> arch/x86/kernel/i8259.c:234: warning: No description found for parameter 'trigger'
--
>> arch/x86/kernel/tsc.c:1163: warning: No description found for parameter 'work'
--
>> arch/x86/mm/pgtable.c:558: warning: No description found for parameter 'reserve'
>> arch/x86/mm/pgtable.c:595: warning: No description found for parameter 'p4d'
>> arch/x86/mm/pgtable.c:595: warning: No description found for parameter 'addr'
>> arch/x86/mm/pgtable.c:595: warning: No description found for parameter 'prot'
arch/x86/mm/pgtable.c:605: warning: No description found for parameter 'p4d'
>> arch/x86/mm/pgtable.c:629: warning: No description found for parameter 'pud'
arch/x86/mm/pgtable.c:629: warning: No description found for parameter 'addr'
arch/x86/mm/pgtable.c:629: warning: No description found for parameter 'prot'
>> arch/x86/mm/pgtable.c:654: warning: No description found for parameter 'pmd'
arch/x86/mm/pgtable.c:654: warning: No description found for parameter 'addr'
arch/x86/mm/pgtable.c:654: warning: No description found for parameter 'prot'
arch/x86/mm/pgtable.c:680: warning: No description found for parameter 'pud'
arch/x86/mm/pgtable.c:695: warning: No description found for parameter 'pmd'
--
>> arch/x86/events/intel/pt.c:1064: warning: No description found for parameter 'nr_pages'
>> arch/x86/events/intel/pt.c:1064: warning: Excess function parameter 'size' description in 'pt_buffer_init_topa'
--
>> drivers/base/attribute_container.c:255: warning: No description found for parameter 'fn'
>> drivers/base/attribute_container.c:369: warning: No description found for parameter 'cont'
>> drivers/base/attribute_container.c:369: warning: No description found for parameter 'dev'
>> drivers/base/attribute_container.c:369: warning: No description found for parameter 'classdev'
--
>> kernel//events/core.c:133: warning: No description found for parameter 'cpu'
>> kernel//events/core.c:9911: warning: No description found for parameter 'flags'
>> kernel//events/core.c:10350: warning: No description found for parameter 'overflow_handler'
>> kernel//events/core.c:10350: warning: No description found for parameter 'context'
--
>> kernel//events/hw_breakpoint.c:420: warning: No description found for parameter 'context'
>> kernel//events/hw_breakpoint.c:434: warning: Excess function parameter 'triggered' description in 'modify_user_hw_breakpoint'
>> kernel//events/hw_breakpoint.c:434: warning: Excess function parameter 'tsk' description in 'modify_user_hw_breakpoint'
kernel//events/hw_breakpoint.c:502: warning: No description found for parameter 'context'
--
>> kernel//irq/devres.c:103: warning: Excess function parameter 'thread_fn' description in 'devm_request_any_context_irq'
--
>> kernel//power/qos.c:476: warning: No description found for parameter 'new_value'
>> kernel//power/qos.c:476: warning: Excess function parameter 'value' description in 'pm_qos_update_request'
--
>> kernel//time/timekeeping.c:370: warning: No description found for parameter 'tkf'
kernel//time/timekeeping.c:419: warning: No description found for parameter 'tkf'
>> kernel//time/timekeeping.c:568: warning: No description found for parameter 'nb'
kernel//time/timekeeping.c:587: warning: No description found for parameter 'nb'
>> kernel//time/timekeeping.c:680: warning: No description found for parameter 'tk'
>> kernel//time/timekeeping.c:1268: warning: No description found for parameter 'ts'
>> kernel//time/timekeeping.c:1268: warning: Excess function parameter 'tv' description in 'timekeeping_inject_offset'
kernel//time/timekeeping.c:1313: warning: No description found for parameter 'tk'
>> kernel//time/timekeeping.c:1313: warning: No description found for parameter 'tai_offset'
>> kernel//time/timekeeping.c:1324: warning: No description found for parameter 'data'
kernel//time/timekeeping.c:1449: warning: No description found for parameter 'ts'
kernel//time/timekeeping.c:1472: warning: No description found for parameter 'ts'
kernel//time/timekeeping.c:1545: warning: No description found for parameter 'tk'
kernel//time/timekeeping.c:1963: warning: No description found for parameter 'tk'
kernel//time/timekeeping.c:2004: warning: No description found for parameter 'tk'
>> kernel//time/timekeeping.c:2004: warning: No description found for parameter 'offset'
>> kernel//time/timekeeping.c:2004: warning: No description found for parameter 'shift'
>> kernel//time/timekeeping.c:2004: warning: No description found for parameter 'clock_set'
>> kernel//time/timekeeping.c:2254: warning: No description found for parameter 'txc'
>> kernel//time/timekeeping.c:2307: warning: No description found for parameter 'phase_ts'
>> kernel//time/timekeeping.c:2307: warning: No description found for parameter 'raw_ts'
..

vim +114 fs//attr.c

^1da177e4 Linus Torvalds 2005-04-16 97
25d9e2d15 npiggin@xxxxxxx 2009-08-21 98 /**
25d9e2d15 npiggin@xxxxxxx 2009-08-21 99 * inode_newsize_ok - may this inode be truncated to a given size
25d9e2d15 npiggin@xxxxxxx 2009-08-21 100 * @inode: the inode to be truncated
25d9e2d15 npiggin@xxxxxxx 2009-08-21 101 * @offset: the new size to assign to the inode
25d9e2d15 npiggin@xxxxxxx 2009-08-21 102 * @Returns: 0 on success, -ve errno on failure
25d9e2d15 npiggin@xxxxxxx 2009-08-21 103 *
7bb46a673 npiggin@xxxxxxx 2010-05-27 104 * inode_newsize_ok must be called with i_mutex held.
7bb46a673 npiggin@xxxxxxx 2010-05-27 105 *
25d9e2d15 npiggin@xxxxxxx 2009-08-21 106 * inode_newsize_ok will check filesystem limits and ulimits to check that the
25d9e2d15 npiggin@xxxxxxx 2009-08-21 107 * new inode size is within limits. inode_newsize_ok will also send SIGXFSZ
25d9e2d15 npiggin@xxxxxxx 2009-08-21 108 * when necessary. Caller must not proceed with inode size change if failure is
25d9e2d15 npiggin@xxxxxxx 2009-08-21 109 * returned. @inode must be a file (not directory), with appropriate
25d9e2d15 npiggin@xxxxxxx 2009-08-21 110 * permissions to allow truncate (inode_newsize_ok does NOT check these
25d9e2d15 npiggin@xxxxxxx 2009-08-21 111 * conditions).
25d9e2d15 npiggin@xxxxxxx 2009-08-21 112 */
25d9e2d15 npiggin@xxxxxxx 2009-08-21 113 int inode_newsize_ok(const struct inode *inode, loff_t offset)
25d9e2d15 npiggin@xxxxxxx 2009-08-21 @114 {
25d9e2d15 npiggin@xxxxxxx 2009-08-21 115 if (inode->i_size < offset) {
25d9e2d15 npiggin@xxxxxxx 2009-08-21 116 unsigned long limit;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 117
d554ed895 Jiri Slaby 2010-03-05 118 limit = rlimit(RLIMIT_FSIZE);
25d9e2d15 npiggin@xxxxxxx 2009-08-21 119 if (limit != RLIM_INFINITY && offset > limit)
25d9e2d15 npiggin@xxxxxxx 2009-08-21 120 goto out_sig;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 121 if (offset > inode->i_sb->s_maxbytes)
25d9e2d15 npiggin@xxxxxxx 2009-08-21 122 goto out_big;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 123 } else {
25d9e2d15 npiggin@xxxxxxx 2009-08-21 124 /*
25d9e2d15 npiggin@xxxxxxx 2009-08-21 125 * truncation of in-use swapfiles is disallowed - it would
25d9e2d15 npiggin@xxxxxxx 2009-08-21 126 * cause subsequent swapout to scribble on the now-freed
25d9e2d15 npiggin@xxxxxxx 2009-08-21 127 * blocks.
25d9e2d15 npiggin@xxxxxxx 2009-08-21 128 */
25d9e2d15 npiggin@xxxxxxx 2009-08-21 129 if (IS_SWAPFILE(inode))
25d9e2d15 npiggin@xxxxxxx 2009-08-21 130 return -ETXTBSY;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 131 }
25d9e2d15 npiggin@xxxxxxx 2009-08-21 132
25d9e2d15 npiggin@xxxxxxx 2009-08-21 133 return 0;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 134 out_sig:
25d9e2d15 npiggin@xxxxxxx 2009-08-21 135 send_sig(SIGXFSZ, current, 0);
25d9e2d15 npiggin@xxxxxxx 2009-08-21 136 out_big:
25d9e2d15 npiggin@xxxxxxx 2009-08-21 137 return -EFBIG;
25d9e2d15 npiggin@xxxxxxx 2009-08-21 138 }
25d9e2d15 npiggin@xxxxxxx 2009-08-21 139 EXPORT_SYMBOL(inode_newsize_ok);
25d9e2d15 npiggin@xxxxxxx 2009-08-21 140
7bb46a673 npiggin@xxxxxxx 2010-05-27 141 /**
6a1a90ad1 Christoph Hellwig 2010-06-04 142 * setattr_copy - copy simple metadata updates into the generic inode
7bb46a673 npiggin@xxxxxxx 2010-05-27 143 * @inode: the inode to be updated
7bb46a673 npiggin@xxxxxxx 2010-05-27 144 * @attr: the new attributes
7bb46a673 npiggin@xxxxxxx 2010-05-27 145 *
6a1a90ad1 Christoph Hellwig 2010-06-04 146 * setattr_copy must be called with i_mutex held.
7bb46a673 npiggin@xxxxxxx 2010-05-27 147 *
6a1a90ad1 Christoph Hellwig 2010-06-04 148 * setattr_copy updates the inode's metadata with that specified
25985edce Lucas De Marchi 2011-03-30 149 * in attr. Noticeably missing is inode size update, which is more complex
2c27c65ed Christoph Hellwig 2010-06-04 150 * as it requires pagecache updates.
7bb46a673 npiggin@xxxxxxx 2010-05-27 151 *
7bb46a673 npiggin@xxxxxxx 2010-05-27 152 * The inode is not marked as dirty after this operation. The rationale is
7bb46a673 npiggin@xxxxxxx 2010-05-27 153 * that for "simple" filesystems, the struct inode is the inode storage.
7bb46a673 npiggin@xxxxxxx 2010-05-27 154 * The caller is free to mark the inode dirty afterwards if needed.
7bb46a673 npiggin@xxxxxxx 2010-05-27 155 */
6a1a90ad1 Christoph Hellwig 2010-06-04 156 void setattr_copy(struct inode *inode, const struct iattr *attr)
^1da177e4 Linus Torvalds 2005-04-16 157 {
^1da177e4 Linus Torvalds 2005-04-16 158 unsigned int ia_valid = attr->ia_valid;
4a30131e7 NeilBrown 2006-01-08 159
^1da177e4 Linus Torvalds 2005-04-16 160 if (ia_valid & ATTR_UID)
^1da177e4 Linus Torvalds 2005-04-16 161 inode->i_uid = attr->ia_uid;
^1da177e4 Linus Torvalds 2005-04-16 162 if (ia_valid & ATTR_GID)
^1da177e4 Linus Torvalds 2005-04-16 163 inode->i_gid = attr->ia_gid;
^1da177e4 Linus Torvalds 2005-04-16 164 if (ia_valid & ATTR_ATIME)
^1da177e4 Linus Torvalds 2005-04-16 165 inode->i_atime = timespec_trunc(attr->ia_atime,
^1da177e4 Linus Torvalds 2005-04-16 166 inode->i_sb->s_time_gran);
^1da177e4 Linus Torvalds 2005-04-16 167 if (ia_valid & ATTR_MTIME)
^1da177e4 Linus Torvalds 2005-04-16 168 inode->i_mtime = timespec_trunc(attr->ia_mtime,
^1da177e4 Linus Torvalds 2005-04-16 169 inode->i_sb->s_time_gran);
^1da177e4 Linus Torvalds 2005-04-16 170 if (ia_valid & ATTR_CTIME)
^1da177e4 Linus Torvalds 2005-04-16 171 inode->i_ctime = timespec_trunc(attr->ia_ctime,
^1da177e4 Linus Torvalds 2005-04-16 172 inode->i_sb->s_time_gran);
^1da177e4 Linus Torvalds 2005-04-16 173 if (ia_valid & ATTR_MODE) {
^1da177e4 Linus Torvalds 2005-04-16 174 umode_t mode = attr->ia_mode;
^1da177e4 Linus Torvalds 2005-04-16 175
7fa294c89 Eric W. Biederman 2012-09-02 176 if (!in_group_p(inode->i_gid) &&
23adbe12e Andy Lutomirski 2014-06-10 177 !capable_wrt_inode_uidgid(inode, CAP_FSETID))
^1da177e4 Linus Torvalds 2005-04-16 178 mode &= ~S_ISGID;
^1da177e4 Linus Torvalds 2005-04-16 179 inode->i_mode = mode;
^1da177e4 Linus Torvalds 2005-04-16 180 }
7bb46a673 npiggin@xxxxxxx 2010-05-27 181 }
6a1a90ad1 Christoph Hellwig 2010-06-04 182 EXPORT_SYMBOL(setattr_copy);
7bb46a673 npiggin@xxxxxxx 2010-05-27 183
27ac0ffea J. Bruce Fields 2011-09-20 184 /**
27ac0ffea J. Bruce Fields 2011-09-20 185 * notify_change - modify attributes of a filesytem object
27ac0ffea J. Bruce Fields 2011-09-20 186 * @dentry: object affected
27ac0ffea J. Bruce Fields 2011-09-20 187 * @iattr: new attributes
27ac0ffea J. Bruce Fields 2011-09-20 188 * @delegated_inode: returns inode, if the inode is delegated
27ac0ffea J. Bruce Fields 2011-09-20 189 *
27ac0ffea J. Bruce Fields 2011-09-20 190 * The caller must hold the i_mutex on the affected object.
27ac0ffea J. Bruce Fields 2011-09-20 191 *
27ac0ffea J. Bruce Fields 2011-09-20 192 * If notify_change discovers a delegation in need of breaking,
27ac0ffea J. Bruce Fields 2011-09-20 193 * it will return -EWOULDBLOCK and return a reference to the inode in
27ac0ffea J. Bruce Fields 2011-09-20 194 * delegated_inode. The caller should then break the delegation and
27ac0ffea J. Bruce Fields 2011-09-20 195 * retry. Because breaking a delegation may take a long time, the
27ac0ffea J. Bruce Fields 2011-09-20 196 * caller should drop the i_mutex before doing so.
27ac0ffea J. Bruce Fields 2011-09-20 197 *
27ac0ffea J. Bruce Fields 2011-09-20 198 * Alternatively, a caller may pass NULL for delegated_inode. This may
27ac0ffea J. Bruce Fields 2011-09-20 199 * be appropriate for callers that expect the underlying filesystem not
27ac0ffea J. Bruce Fields 2011-09-20 200 * to be NFS exported. Also, passing NULL is fine for callers holding
27ac0ffea J. Bruce Fields 2011-09-20 201 * the file open for write, as there can be no conflicting delegation in
27ac0ffea J. Bruce Fields 2011-09-20 202 * that case.
27ac0ffea J. Bruce Fields 2011-09-20 203 */
27ac0ffea J. Bruce Fields 2011-09-20 204 int notify_change(struct dentry * dentry, struct iattr * attr, struct inode **delegated_inode)
^1da177e4 Linus Torvalds 2005-04-16 @205 {

:::::: The code at line 114 was first introduced by commit
:::::: 25d9e2d15286281ec834b829a4aaf8969011f1cd truncate: new helpers

:::::: TO: npiggin@xxxxxxx <npiggin@xxxxxxx>
:::::: CC: al <al@xxxxxxxxxxxxxxxxx>

---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation

Attachment: .config.gz
Description: application/gzip

Next message: Julio Candela CPat: "[no subject]"
Previous message: Steven Rostedt: "Re: [GIT PULL] tracing/samples: Fix creation and deletion of simple_thread_fn creation"
In reply to: Matthew Wilcox: "[PATCH] Check all .c files for bad kernel-doc comments"
Next in thread: kbuild test robot: "Re: [PATCH] Check all .c files for bad kernel-doc comments"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]