aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2008-04-25 11:56:37 -0600
committerJonathan Corbet <corbet@lwn.net>2008-04-25 11:56:37 -0600
commit9f4def9ae4772ea3da5e2359de698742ebae53b5 (patch)
tree7c5a0297807ec25149a8287abcdc05c4969a0eb8 /Documentation
parent0fe8a3ce73ef31d1480e82798503948a979e8e52 (diff)
downloadlinux-stericsson-9f4def9ae4772ea3da5e2359de698742ebae53b5.tar.gz
Document seq_path_root()
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/filesystems/seq_file.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/Documentation/filesystems/seq_file.txt b/Documentation/filesystems/seq_file.txt
index 0ab92c260894..b843743aa0b5 100644
--- a/Documentation/filesystems/seq_file.txt
+++ b/Documentation/filesystems/seq_file.txt
@@ -187,12 +187,18 @@ The first two output a single character and a string, just like one would
expect. seq_escape() is like seq_puts(), except that any character in s
which is in the string esc will be represented in octal form in the output.
-There is also a function for printing filenames:
+There is also a pair of functions for printing filenames:
int seq_path(struct seq_file *m, struct path *path, char *esc);
+ int seq_path_root(struct seq_file *m, struct path *path,
+ struct path *root, char *esc)
Here, path indicates the file of interest, and esc is a set of characters
-which should be escaped in the output.
+which should be escaped in the output. A call to seq_path() will output
+the path relative to the current process's filesystem root. If a different
+root is desired, it can be used with seq_path_root(). Note that, if it
+turns out that path cannot be reached from root, the value of root will be
+changed in seq_file_root() to a root which *does* work.
Making it all work