diff options
| -rw-r--r-- | Documentation/filesystems/seq_file.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/filesystems/seq_file.txt b/Documentation/filesystems/seq_file.txt index 7fb8e6dc62bf..0ab92c260894 100644 --- a/Documentation/filesystems/seq_file.txt +++ b/Documentation/filesystems/seq_file.txt | |||
| @@ -122,8 +122,7 @@ stop() is the place to free it. | |||
| 122 | } | 122 | } |
| 123 | 123 | ||
| 124 | Finally, the show() function should format the object currently pointed to | 124 | Finally, the show() function should format the object currently pointed to |
| 125 | by the iterator for output. It should return zero, or an error code if | 125 | by the iterator for output. The example module's show() function is: |
| 126 | something goes wrong. The example module's show() function is: | ||
| 127 | 126 | ||
| 128 | static int ct_seq_show(struct seq_file *s, void *v) | 127 | static int ct_seq_show(struct seq_file *s, void *v) |
| 129 | { | 128 | { |
| @@ -132,6 +131,12 @@ something goes wrong. The example module's show() function is: | |||
| 132 | return 0; | 131 | return 0; |
| 133 | } | 132 | } |
| 134 | 133 | ||
| 134 | If all is well, the show() function should return zero. A negative error | ||
| 135 | code in the usual manner indicates that something went wrong; it will be | ||
| 136 | passed back to user space. This function can also return SEQ_SKIP, which | ||
| 137 | causes the current item to be skipped; if the show() function has already | ||
| 138 | generated output before returning SEQ_SKIP, that output will be dropped. | ||
| 139 | |||
| 135 | We will look at seq_printf() in a moment. But first, the definition of the | 140 | We will look at seq_printf() in a moment. But first, the definition of the |
| 136 | seq_file iterator is finished by creating a seq_operations structure with | 141 | seq_file iterator is finished by creating a seq_operations structure with |
| 137 | the four functions we have just defined: | 142 | the four functions we have just defined: |
