libfs: document simple_get_link()

6ee9706a · Eric Biggers <[email protected]> · 2019-04-11 16:16:30 -07:00

Signed-off-by: Eric Biggers <[email protected]>
Signed-off-by: Al Viro <[email protected]>

Changes

1 files changed · +14 −0

File	Status	Add	Del	Content
fs/libfs.c	modified	+14	−0	View file

diff --git a/fs/libfs.c b/fs/libfs.c
index 0fb590d..5f74a98 100644
--- a/fs/libfs.c
+++ b/fs/libfs.c
@@ -1167,6 +1167,20 @@ simple_nosetlease(struct file *filp, long arg, struct file_lock **flp,
 }
 EXPORT_SYMBOL(simple_nosetlease);
 
+/**
+ * simple_get_link - generic helper to get the target of "fast" symlinks
+ * @dentry: not used here
+ * @inode: the symlink inode
+ * @done: not used here
+ *
+ * Generic helper for filesystems to use for symlink inodes where a pointer to
+ * the symlink target is stored in ->i_link.  NOTE: this isn't normally called,
+ * since as an optimization the path lookup code uses any non-NULL ->i_link
+ * directly, without calling ->get_link().  But ->get_link() still must be set,
+ * to mark the inode_operations as being for a symlink.
+ *
+ * Return: the symlink target
+ */
 const char *simple_get_link(struct dentry *dentry, struct inode *inode,
 			    struct delayed_call *done)
 {