diff options
| author | Arjan van de Ven <arjan@infradead.org> | 2008-12-01 14:35:00 -0800 |
|---|---|---|
| committer | Al Viro <viro@zeniv.linux.org.uk> | 2008-12-31 18:07:41 -0500 |
| commit | 52afeefb9dac9287429642189996426a2bfd6a25 (patch) | |
| tree | cbc7baf2a2f4e8dc16861ad4b13de0183f4afa7e | |
| parent | be42c4c433c2c0d3f1583c08908fead00d36d222 (diff) | |
| download | linux-3.10-52afeefb9dac9287429642189996426a2bfd6a25.tar.gz linux-3.10-52afeefb9dac9287429642189996426a2bfd6a25.tar.bz2 linux-3.10-52afeefb9dac9287429642189996426a2bfd6a25.zip | |
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>
| -rw-r--r-- | fs/dcache.c | 8 | ||||
| -rw-r--r-- | fs/seq_file.c | 10 |
2 files changed, 14 insertions, 4 deletions
diff --git a/fs/dcache.c b/fs/dcache.c index c231a639c2a..bdb3f50248a 100644 --- a/fs/dcache.c +++ b/fs/dcache.c @@ -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 * 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. * @@ -1984,7 +1985,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. */ diff --git a/fs/seq_file.c b/fs/seq_file.c index 16c211558c2..99d8b8cfc9b 100644 --- a/fs/seq_file.c +++ b/fs/seq_file.c @@ -389,8 +389,14 @@ char *mangle_path(char *s, char *p, char *esc) } 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) { |