diff options
author | Dmitry V. Levin <ldv@altlinux.org> | 2012-10-17 12:29:22 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2014-12-29 17:40:18 -0500 |
commit | 380945365d3824e7c62deb17930453acdcb65eaa (patch) | |
tree | dc4994d817881bb1fba5f5a3677576b001fcd856 /Documentation/filesystems | |
parent | bf5777bcdc540661f2f5d531a13e4e9c9fb7ee22 (diff) |
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>
Diffstat (limited to 'Documentation/filesystems')
-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. | |||
194 | 194 | ||
195 | There are also a pair of functions for printing filenames: | 195 | There are also a pair of functions for printing filenames: |
196 | 196 | ||
197 | int seq_path(struct seq_file *m, struct path *path, char *esc); | 197 | int seq_path(struct seq_file *m, const struct path *path, |
198 | int seq_path_root(struct seq_file *m, struct path *path, | 198 | const char *esc); |
199 | struct path *root, char *esc) | 199 | int seq_path_root(struct seq_file *m, const struct path *path, |
200 | const struct path *root, const char *esc) | ||
200 | 201 | ||
201 | Here, path indicates the file of interest, and esc is a set of characters | 202 | Here, path indicates the file of interest, and esc is a set of characters |
202 | which should be escaped in the output. A call to seq_path() will output | 203 | which should be escaped in the output. A call to seq_path() will output |
203 | the path relative to the current process's filesystem root. If a different | 204 | the path relative to the current process's filesystem root. If a different |
204 | root is desired, it can be used with seq_path_root(). Note that, if it | 205 | root is desired, it can be used with seq_path_root(). If it turns out that |
205 | turns out that path cannot be reached from root, the value of root will be | 206 | path cannot be reached from root, seq_path_root() returns SEQ_SKIP. |
206 | changed in seq_file_root() to a root which *does* work. | ||
207 | 207 | ||
208 | A function producing complicated output may want to check | 208 | A function producing complicated output may want to check |
209 | bool seq_has_overflowed(struct seq_file *m); | 209 | bool seq_has_overflowed(struct seq_file *m); |