Commit 460b865e authored Jun 30, 2015 by Yann Droneaud Committed by Linus Torvalds Jun 30, 2015

fs: document seq_open()'s usage of file->private_data

seq_open() stores its struct seq_file in file->private_data, thus it must
not be modified by user of seq_file.

Link: http://lkml.kernel.org/r/cover.1433193673.git.ydroneaud@opteya.com


Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

parent 189f9841

fs/seq_file.c

+2 −0

Original line number	Diff line number	Diff line
		@@ -48,6 +48,8 @@ static void *seq_buf_alloc(unsigned long size)
		* ERR_PTR(error). In the end of sequence they return %NULL. ->show()
		* returns 0 in case of success and negative number in case of error.
		* Returning SEQ_SKIP means "discard this element and move on".
		* Note: seq_open() will allocate a struct seq_file and store its
		* pointer in @file->private_data. This pointer should not be modified.
		*/
		int seq_open(struct file file, const struct seq_operations op)
		{