diff options
author | Dmitry V. Levin <ldv@altlinux.org> | 2012-10-17 20:29:22 +0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2014-12-29 15:40:18 -0700 |
commit | 380945365d3824e7c62deb17930453acdcb65eaa (patch) | |
tree | dc4994d817881bb1fba5f5a3677576b001fcd856 | |
parent | bf5777bcdc540661f2f5d531a13e4e9c9fb7ee22 (diff) | |
download | linux-380945365d3824e7c62deb17930453acdcb65eaa.tar.gz linux-380945365d3824e7c62deb17930453acdcb65eaa.tar.bz2 linux-380945365d3824e7c62deb17930453acdcb65eaa.zip |
Documentation: update seq_file
Update descriptions of seq_path() and seq_path_root():
starting with commit v3.2-rc4-1-g02125a8, seq_path_root() no longer
changes the value of root;
starting with commit v3.2-rc7-104-g8c9379e, some arguments of seq_path()
and seq_path_root() are const.
Signed-off-by: Dmitry V. Levin <ldv@altlinux.org>
Acked-by: Rob Landley <rob@landley.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r-- | Documentation/filesystems/seq_file.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/filesystems/seq_file.txt b/Documentation/filesystems/seq_file.txt index b797ed38de46..9de4303201e1 100644 --- a/Documentation/filesystems/seq_file.txt +++ b/Documentation/filesystems/seq_file.txt @@ -194,16 +194,16 @@ which is in the string esc will be represented in octal form in the output. There are 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) + int seq_path(struct seq_file *m, const struct path *path, + const char *esc); + int seq_path_root(struct seq_file *m, const struct path *path, + const struct path *root, const char *esc) Here, path indicates the file of interest, and esc is a set of characters 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. +root is desired, it can be used with seq_path_root(). If it turns out that +path cannot be reached from root, seq_path_root() returns SEQ_SKIP. A function producing complicated output may want to check bool seq_has_overflowed(struct seq_file *m); |