vfs: expand some comments (d_path / seq_path)
PATCH 10/11 vfs: expand some comments (d_path / seq_path)
From: Arjan van de Ven <[email protected]>
Explain that you really need to use the return value of d_path rather than the buffer you passed into it.
Also fix the comment for seq_path(), the function arguments changed recently but the comment hadn't been updated in sync.
Signed-off-by Arjan van de Ven <[email protected]>
Cc Al Viro <[email protected]>
Cc Christoph Hellwig <[email protected]>
Signed-off-by Andrew Morton <[email protected]>
---
fs/dcache.c | 8 ++++++-- fs/seq_file.c | 10 ++++++++-- 2 files changed, 14 insertions(+), 4 deletions(-)
fs/dcache.c renamed from fs/dcache.c~vfs-expand-some-comments-d_path-seq_path +6 -2
@@ -1912,7 +1912,8 @@ static int prepend_name(char **buffer, i* 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. +* Returns a pointer into the buffer or an error code if the +* path was too long. * * "buflen" should be positive. Caller holds the dcache_lock. *
@@ -1988,7 +1989,10 @@ Elong:* 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. +* Returns a pointer into the buffer or an error code if the path was +* too long. Note: Callers should use the returned pointer, not the passed +* in buffer, to use the name! The implementation often starts at an offset +* into the buffer, and may leave 0 bytes at the start. * * "buflen" should be positive. */
fs/seq_file.c renamed from fs/seq_file.c~vfs-expand-some-comments-d_path-seq_path +8 -2
@@ -389,8 +389,14 @@ char *mangle_path(char *s, char *p, char }EXPORT_SYMBOL_GPL (mangle_path); -/* -* return the absolute path of 'dentry' residing in mount 'mnt'. +/** +* seq_path - seq_file interface to print a pathname +* @m: the seq_file handle +* @path: the struct path to print +* @esc: set of characters to escape in the output +* +* return the absolute path of 'path', as represented by the +* dentry / mnt pair in the path parameter. */ int seq_path (struct seq_file *m,struct path *path,char *esc) {
_