Commit 52afeefb9dac9287429642189996426a2bfd6a25
Committed by
Al Viro
Al Viro
1 parent
be42c4c433
Exists in
master
and in
7 other branches
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: Arjan van de Ven <arjan@linux.intel.com> Cc: Al Viro <viro@zeniv.linux.org.uk> Cc: Christoph Hellwig <hch@lst.de> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
Showing 2 changed files with 14 additions and 4 deletions Side-by-side Diff
fs/dcache.c
| ... | ... | @@ -1908,7 +1908,8 @@ |
| 1908 | 1908 | * Convert a dentry into an ASCII path name. If the entry has been deleted |
| 1909 | 1909 | * the string " (deleted)" is appended. Note that this is ambiguous. |
| 1910 | 1910 | * |
| 1911 | - * Returns the buffer or an error code if the path was too long. | |
| 1911 | + * Returns a pointer into the buffer or an error code if the | |
| 1912 | + * path was too long. | |
| 1912 | 1913 | * |
| 1913 | 1914 | * "buflen" should be positive. Caller holds the dcache_lock. |
| 1914 | 1915 | * |
| ... | ... | @@ -1984,7 +1985,10 @@ |
| 1984 | 1985 | * Convert a dentry into an ASCII path name. If the entry has been deleted |
| 1985 | 1986 | * the string " (deleted)" is appended. Note that this is ambiguous. |
| 1986 | 1987 | * |
| 1987 | - * Returns the buffer or an error code if the path was too long. | |
| 1988 | + * Returns a pointer into the buffer or an error code if the path was | |
| 1989 | + * too long. Note: Callers should use the returned pointer, not the passed | |
| 1990 | + * in buffer, to use the name! The implementation often starts at an offset | |
| 1991 | + * into the buffer, and may leave 0 bytes at the start. | |
| 1988 | 1992 | * |
| 1989 | 1993 | * "buflen" should be positive. |
| 1990 | 1994 | */ |
fs/seq_file.c
| ... | ... | @@ -389,8 +389,14 @@ |
| 389 | 389 | } |
| 390 | 390 | EXPORT_SYMBOL(mangle_path); |
| 391 | 391 | |
| 392 | -/* | |
| 393 | - * return the absolute path of 'dentry' residing in mount 'mnt'. | |
| 392 | +/** | |
| 393 | + * seq_path - seq_file interface to print a pathname | |
| 394 | + * @m: the seq_file handle | |
| 395 | + * @path: the struct path to print | |
| 396 | + * @esc: set of characters to escape in the output | |
| 397 | + * | |
| 398 | + * return the absolute path of 'path', as represented by the | |
| 399 | + * dentry / mnt pair in the path parameter. | |
| 394 | 400 | */ |
| 395 | 401 | int seq_path(struct seq_file *m, struct path *path, char *esc) |
| 396 | 402 | { |