Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 52afeefb authored by Arjan van de Ven's avatar Arjan van de Ven Committed by Al Viro
Browse files

expand some comments (d_path / seq_path) 



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: default avatarArjan van de Ven <arjan@linux.intel.com>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Cc: Christoph Hellwig <hch@lst.de>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarAl Viro <viro@zeniv.linux.org.uk>
parent be42c4c4

fs/dcache.c

+6 −2
Original line number Original line Diff line number Diff line
@@ -1908,7 +1908,8 @@ static int prepend_name(char **buffer, int *buflen, struct qstr *name) 
 * Convert a dentry into an ASCII path name. If the entry has been deleted

 * Convert a dentry into an ASCII path name. If the entry has been deleted

 * the string " (deleted)" is appended. Note that this is ambiguous.

 * 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.

 * "buflen" should be positive. Caller holds the dcache_lock.

 *

 *
@@ -1984,7 +1985,10 @@ Elong: 
 * Convert a dentry into an ASCII path name. If the entry has been deleted

 * Convert a dentry into an ASCII path name. If the entry has been deleted

 * the string " (deleted)" is appended. Note that this is ambiguous.

 * 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.

 * "buflen" should be positive.

 */

 */

fs/seq_file.c

+8 −2
Original line number Original line Diff line number Diff line
@@ -389,8 +389,14 @@ char *mangle_path(char *s, char *p, char *esc) 
}

}

EXPORT_SYMBOL(mangle_path);

EXPORT_SYMBOL(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)

int seq_path(struct seq_file *m, struct path *path, char *esc)

{

{