Skip to content

Commit cc15422

Browse files
committed
Merge tag 'fs.idmapped.docs.v5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/brauner/linux
Pull fs helper kernel-doc updates from Christian Brauner: "In the last cycles we forgot to update the kernel-docs in some places that were changed during the idmapped mount work. Lukas and Randy took the chance to not just fixup those places but also fixup and expand kernel-docs for some additional helpers. No functional changes" * tag 'fs.idmapped.docs.v5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/brauner/linux: fs: update kernel-doc for vfs_rename() fs: turn some comments into kernel-doc xattr: fix kernel-doc for mnt_userns and vfs xattr helpers namei: fix kernel-doc for struct renamedata and more libfs: fix kernel-doc for mnt_userns
2 parents b34b95e + 92cb01c commit cc15422

File tree

4 files changed

+26
-20
lines changed

4 files changed

+26
-20
lines changed

fs/libfs.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,7 @@ EXPORT_SYMBOL(simple_rename);
481481

482482
/**
483483
* simple_setattr - setattr for simple filesystem
484+
* @mnt_userns: user namespace of the target mount
484485
* @dentry: dentry
485486
* @iattr: iattr structure
486487
*

fs/namei.c

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1126,8 +1126,7 @@ int may_linkat(struct user_namespace *mnt_userns, struct path *link)
11261126
* should be allowed, or not, on files that already
11271127
* exist.
11281128
* @mnt_userns: user namespace of the mount the inode was found from
1129-
* @dir_mode: mode bits of directory
1130-
* @dir_uid: owner of directory
1129+
* @nd: nameidata pathwalk data
11311130
* @inode: the inode of the file to open
11321131
*
11331132
* Block an O_CREAT open of a FIFO (or a regular file) when:
@@ -3383,7 +3382,7 @@ static int do_open(struct nameidata *nd,
33833382
* @mnt_userns: user namespace of the mount the inode was found from
33843383
* @dentry: pointer to dentry of the base directory
33853384
* @mode: mode of the new tmpfile
3386-
* @open_flags: flags
3385+
* @open_flag: flags
33873386
*
33883387
* Create a temporary file.
33893388
*
@@ -4408,14 +4407,7 @@ SYSCALL_DEFINE2(link, const char __user *, oldname, const char __user *, newname
44084407

44094408
/**
44104409
* vfs_rename - rename a filesystem object
4411-
* @old_mnt_userns: old user namespace of the mount the inode was found from
4412-
* @old_dir: parent of source
4413-
* @old_dentry: source
4414-
* @new_mnt_userns: new user namespace of the mount the inode was found from
4415-
* @new_dir: parent of destination
4416-
* @new_dentry: destination
4417-
* @delegated_inode: returns an inode needing a delegation break
4418-
* @flags: rename flags
4410+
* @rd: pointer to &struct renamedata info
44194411
*
44204412
* The caller must hold multiple mutexes--see lock_rename()).
44214413
*

fs/xattr.c

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -186,12 +186,12 @@ EXPORT_SYMBOL(__vfs_setxattr);
186186
* __vfs_setxattr_noperm - perform setxattr operation without performing
187187
* permission checks.
188188
*
189-
* @mnt_userns - user namespace of the mount the inode was found from
190-
* @dentry - object to perform setxattr on
191-
* @name - xattr name to set
192-
* @value - value to set @name to
193-
* @size - size of @value
194-
* @flags - flags to pass into filesystem operations
189+
* @mnt_userns: user namespace of the mount the inode was found from
190+
* @dentry: object to perform setxattr on
191+
* @name: xattr name to set
192+
* @value: value to set @name to
193+
* @size: size of @value
194+
* @flags: flags to pass into filesystem operations
195195
*
196196
* returns the result of the internal setxattr or setsecurity operations.
197197
*
@@ -242,6 +242,7 @@ int __vfs_setxattr_noperm(struct user_namespace *mnt_userns,
242242
* __vfs_setxattr_locked - set an extended attribute while holding the inode
243243
* lock
244244
*
245+
* @mnt_userns: user namespace of the mount of the target inode
245246
* @dentry: object to perform setxattr on
246247
* @name: xattr name to set
247248
* @value: value to set @name to
@@ -473,6 +474,7 @@ EXPORT_SYMBOL(__vfs_removexattr);
473474
* __vfs_removexattr_locked - set an extended attribute while holding the inode
474475
* lock
475476
*
477+
* @mnt_userns: user namespace of the mount of the target inode
476478
* @dentry: object to perform setxattr on
477479
* @name: name of xattr to remove
478480
* @delegated_inode: on return, will contain an inode pointer that

include/linux/fs.h

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1740,7 +1740,7 @@ static inline void sb_start_pagefault(struct super_block *sb)
17401740
__sb_start_write(sb, SB_FREEZE_PAGEFAULT);
17411741
}
17421742

1743-
/*
1743+
/**
17441744
* sb_start_intwrite - get write access to a superblock for internal fs purposes
17451745
* @sb: the super we write to
17461746
*
@@ -1783,6 +1783,17 @@ int vfs_rmdir(struct user_namespace *, struct inode *, struct dentry *);
17831783
int vfs_unlink(struct user_namespace *, struct inode *, struct dentry *,
17841784
struct inode **);
17851785

1786+
/**
1787+
* struct renamedata - contains all information required for renaming
1788+
* @old_mnt_userns: old user namespace of the mount the inode was found from
1789+
* @old_dir: parent of source
1790+
* @old_dentry: source
1791+
* @new_mnt_userns: new user namespace of the mount the inode was found from
1792+
* @new_dir: parent of destination
1793+
* @new_dentry: destination
1794+
* @delegated_inode: returns an inode needing a delegation break
1795+
* @flags: rename flags
1796+
*/
17861797
struct renamedata {
17871798
struct user_namespace *old_mnt_userns;
17881799
struct inode *old_dir;
@@ -3170,7 +3181,7 @@ static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
31703181

31713182
void inode_dio_wait(struct inode *inode);
31723183

3173-
/*
3184+
/**
31743185
* inode_dio_begin - signal start of a direct I/O requests
31753186
* @inode: inode the direct I/O happens on
31763187
*
@@ -3182,7 +3193,7 @@ static inline void inode_dio_begin(struct inode *inode)
31823193
atomic_inc(&inode->i_dio_count);
31833194
}
31843195

3185-
/*
3196+
/**
31863197
* inode_dio_end - signal finish of a direct I/O requests
31873198
* @inode: inode the direct I/O happens on
31883199
*

0 commit comments

Comments
 (0)