vfs: expand some comments (d_path / seq_path)
PATCH 1/1 vfs: expand some comments (d_path / seq_path)
Quoted 1 line
From
b533b9b615b9d7eb865d63165b29cf7773fa2856Mon Sep 17 00:00:00 2001
From: Arjan van de Ven <[email protected]>
Date: Tue, 4 Nov 2008 21:29:34 -0800
Subject: [PATCH] vfs: 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 <[email protected]>
--- fs/dcache.c | 8 ++++++-- fs/seq_file.c | 10 ++++++++-- 2 files changed, 14 insertions(+), 4 deletions(-)
fs/dcache.c +6 -2
@@ -1911,7 +1911,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. *
@@ -1987,7 +1988,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 +8 -2
@@ -377,8 +377,14 @@ static char *mangle_path(char *s, char *p, char *esc)return NULL ; } -/* -* 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) {
Signature · 8 lines
1.6.0.3 -- Arjan van de Ven Intel Open Source Technology Centre For development, discussion and tips for power savings, visit http://www.lesswatts.org