summaryrefslogtreecommitdiff
path: root/Documentation/filesystems/seq_file.txt
AgeCommit message (Collapse)AuthorFilesLines
2014-12-30Documentation: update seq_fileDmitry V. Levin1-6/+6
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>
2014-10-30seq_file: Rename seq_overflow() to seq_has_overflowed() and make publicJoe Perches1-9/+13
The return values of seq_printf/puts/putc are frequently misused. Start down a path to remove all the return value uses of these functions. Move the seq_overflow() to a global inlined function called seq_has_overflowed() that can be used by the users of seq_file() calls. Update the documentation to not show return types for seq_printf et al. Add a description of seq_has_overflowed(). Link: http://lkml.kernel.org/p/848ac7e3d1c31cddf638a8526fa3c59fa6fdeb8a.1412031505.git.joe@perches.com Cc: Al Viro <viro@zeniv.linux.org.uk> Signed-off-by: Joe Perches <joe@perches.com> [ Reworked the original patch from Joe ] Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-09-08Documentation: seq_file: Document seq_open_private(), seq_release_private()Rob Jones1-0/+33
Despite the fact that these functions have been around for years, they are little used (only 15 uses in 13 files at the preseht time) even though many other files use work-arounds to achieve the same result. By documenting them, hopefully they will become more widely used. Signed-off-by: Rob Jones <rob.jones@codethink.co.uk> Acked-by: Steven Whitehouse <swhiteho@redhat.com> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2014-06-07Documentation/filesystems/seq_file.txt: create_proc_entry deprecatedFabian Frederick1-0/+9
Linked article in seq_file.txt still uses create_proc_entry which was removed in commit 80e928f7ebb9 ("proc: Kill create_proc_entry()"). This patch adds information for kernel 3.10 and above Signed-off-by: Fabian Frederick <fabf@skynet.be> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2009-12-16seq_file: use proc_create() in documentationAlexey Dobriyan1-3/+1
Using create_proc_entry() + ->proc_fops assignment is racy because ->proc_fops will be NULL for some time, use proc_create() to avoid race. Signed-off-by: Alexey Dobriyan <adobriyan@gmail.com> Cc: Randy Dunlap <randy.dunlap@oracle.com> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2009-09-11Doc: seq_file.txt fix wrong dd command example.Jesper Dangaard Brouer1-1/+1
Small error in the "dd" command example, "out=" should be "of=". Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2008-04-25Document seq_path_root()Jonathan Corbet1-2/+8
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2008-04-25Document SEQ_SKIPJonathan Corbet1-2/+7
2.6.26 adds a SEQ_SKIP return value for the seq_file show() function; update the documentation to match. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2008-04-16Fix typos in Documentation/filesystems/seq_file.txtDmitri Vorobiev1-3/+3
A couple of typos crept into the newly added document about the seq_file interface. This patch corrects those typos and simultaneously deletes unnecessary trailing spaces. Signed-off-by: Dmitri Vorobiev <dmitri.vorobiev@gmail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-03-30Fixes to the seq_file documentJan Engelhardt1-7/+7
On Friday 2008-03-28 19:20, Jonathan Corbet wrote: >commit 9756ccfda31b4c4544aa010aacf71b6672d668e8 >Date: Fri Mar 28 11:19:56 2008 -0600 > > Add the seq_file documentation patch on top: - add const qualifiers - remove void* casts - use proper specifier (%Ld is not valid) Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jan Engelhardt <jengelh@computergmbh.de>
2008-03-30Add the seq_file documentationJonathan Corbet1-0/+283
This is an updated version of the document describing the seq_file interface. Signed-off-by: Jonathan Corbet <corbet@lwn.net>