diff options
| author |   NeilBrown <neilb@suse.de> | 2020-09-25 17:14:42 +1000 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2020-09-28 15:19:44 -0600 |
| commit | ce7a7eed776f994d5672ad76adb671580bd083ac (patch) | |
| tree | 1649f63b8b8a85d6fd2f76e9795c92824a584eda /.mailmap | |
| parent | docs: trace: ring-buffer-design.rst: use the new SPDX tag (diff) | |
| download | linux-dev-ce7a7eed776f994d5672ad76adb671580bd083ac.tar.xz linux-dev-ce7a7eed776f994d5672ad76adb671580bd083ac.zip | |
doc: seq_file: clarify role of *pos in ->next()
There are behavioural requirements on the seq_file next() function in
terms of how it updates *pos at end-of-file, and these are now enforced
by a warning.
I was recently attempting to justify the reason this was needed, and
couldn't remember the details, and didn't find them in the
documentation.
So I re-read the code until I understood it again, and updated the
documentation to match.
I also enhanced the text about SEQ_START_TOKEN as it seemed potentially
misleading.
Cc: Vasily Averin <vvs@virtuozzo.com>
Signed-off-by: NeilBrown <neilb@suse.de>
Link: https://lore.kernel.org/r/87eemqiazh.fsf@notabene.neil.brown.name
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to '.mailmap')
0 files changed, 0 insertions, 0 deletions