aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Blunck <jblunck@suse.de>2008-02-14 19:38:32 -0800
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2008-02-14 21:17:08 -0800
commita03a8a709a0c34b61b7aea1d54a0473a6b941fdb (patch)
tree726beca09574c6599ceece7c5cb82c7efed33f18
parent329c97f0af41bd580237b8fad0f3741849ee4e13 (diff)
downloadlinux-2.6.34-ux500-a03a8a709a0c34b61b7aea1d54a0473a6b941fdb.tar.gz
d_path: kerneldoc cleanup
Move and update d_path() kernel API documentation. Signed-off-by: Jan Blunck <jblunck@suse.de> Acked-by: Christoph Hellwig <hch@infradead.org> Cc: Al Viro <viro@zeniv.linux.org.uk> Cc: "J. Bruce Fields" <bfields@fieldses.org> Cc: Neil Brown <neilb@suse.de> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r--fs/dcache.c19
1 files changed, 16 insertions, 3 deletions
diff --git a/fs/dcache.c b/fs/dcache.c
index 688aac951d1..170efbcb1a9 100644
--- a/fs/dcache.c
+++ b/fs/dcache.c
@@ -1843,9 +1843,22 @@ Elong:
return ERR_PTR(-ENAMETOOLONG);
}
-/* write full pathname into buffer and return start of pathname */
-char * d_path(struct dentry *dentry, struct vfsmount *vfsmnt,
- char *buf, int buflen)
+/**
+ * d_path - return the path of a dentry
+ * @dentry: dentry to report
+ * @vfsmnt: vfsmnt to which the dentry belongs
+ * @buf: buffer to return value in
+ * @buflen: buffer length
+ *
+ * Convert a dentry into an ASCII path name. If the entry has been deleted
+ * the string " (deleted)" is appended. Note that this is ambiguous.
+ *
+ * Returns the buffer or an error code if the path was too long.
+ *
+ * "buflen" should be positive. Caller holds the dcache_lock.
+ */
+char *d_path(struct dentry *dentry, struct vfsmount *vfsmnt,
+ char *buf, int buflen)
{
char *res;
struct path root;