linux/Documentation
NeilBrown ce7a7eed77 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>
2020-09-28 15:19:44 -06:00
..
ABI docs: stable-ABI: Document /sys/kernel/notes 2020-09-16 12:17:47 -06:00
PCI pci-v5.9-changes 2020-08-07 18:48:15 -07:00
RCU docs: Fix function name trailing double-()s 2020-08-24 17:19:07 -06:00
accounting
admin-guide Documentation: kernel-parameters: clarify "module." parameters 2020-09-24 11:06:05 -06:00
arm documentation: arm: sunxi: Allwinner H2+/H3 update 2020-09-24 10:35:42 -06:00
arm64 IOMMU Updates for Linux v5.9 2020-08-11 14:13:24 -07:00
block for-5.9/drivers-20200803 2020-08-05 10:51:40 -07:00
bpf bpf, doc: Remove references to warning message when using bpf_trace_printk() 2020-08-07 18:44:56 +02:00
cdrom A handful of obvious fixes that wandered in during the merge window. 2020-08-13 13:57:45 -07:00
core-api Documentation: core-api/cpu_hotplug: fix a typo 2020-09-09 11:42:09 -06:00
cpu-freq
crypto It's been a busy cycle for documentation - hopefully the busiest for a 2020-08-04 22:47:54 -07:00
dev-tools A handful of obvious fixes that wandered in during the merge window. 2020-08-13 13:57:45 -07:00
devicetree Devicetree fixes for v5.9: 2020-08-15 08:19:58 -07:00
doc-guide docs: Document cross-referencing between documentation pages 2020-09-16 11:09:51 -06:00
driver-api docs: dma-buf: fix some warnings 2020-09-10 10:49:43 -06:00
fault-injection block: rename generic_make_request to submit_bio_noacct 2020-07-01 07:27:24 -06:00
fb docs: fb: Remove vesafb scrollback boot option 2020-09-24 10:59:26 -06:00
features A handful of obvious fixes that wandered in during the merge window. 2020-08-13 13:57:45 -07:00
filesystems doc: seq_file: clarify role of *pos in ->next() 2020-09-28 15:19:44 -06:00
firmware-guide docs: add some new files to their respective index.rst files 2020-09-10 10:48:20 -06:00
firmware_class
fpga Char/Misc driver patches for 5.9-rc1 2020-08-05 11:43:47 -07:00
gpu - Core Frameworks 2020-08-11 13:48:02 -07:00
hid docs: hid: Convert link to https 2020-07-13 11:26:37 -06:00
hwmon docs: add some new files to their respective index.rst files 2020-09-10 10:48:20 -06:00
i2c Merge branch 'i2c/for-5.9' of git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux 2020-08-13 18:41:00 -07:00
ia64 docs/ia64: Drop obsolete Xen documentation 2020-08-31 16:16:03 -06:00
ide
iio Documentation: iio: fix a typo 2020-09-09 11:41:20 -06:00
infiniband
input Input: uinput - fix typo in function name documentation 2020-07-28 18:24:11 -07:00
isdn
kbuild Documentation: add minimum clang/llvm version 2020-08-31 16:30:20 -06:00
kernel-hacking
leds LEDs changes for 5.9-rc1. 2020-08-05 19:24:27 -07:00
litmus-tests Documentation/litmus-tests: Add note on herd7 7.56 in atomic litmus test 2020-06-29 12:05:18 -07:00
livepatch
locking Documentation/locking/locktypes: fix local_locks documentation 2020-08-24 17:18:51 -06:00
m68k
maintainer Documentation/maintainer: rehome sign-off process 2020-09-03 15:39:24 -06:00
mhi
mips It's been a busy cycle for documentation - hopefully the busiest for a 2020-08-04 22:47:54 -07:00
misc-devices Documentation: misc/xilinx_sdfec: eliminate duplicated word 2020-07-13 09:44:07 -06:00
netlabel
networking wireless-drivers-next patches for v5.9 2020-08-04 12:57:02 -07:00
nios2
nvdimm
openrisc docs: openrisc: Replace HTTP links with HTTPS ones 2020-07-13 11:34:09 -06:00
parisc
pcmcia
power Merge branches 'pm-sleep', 'pm-domains', 'powercap' and 'pm-tools' 2020-08-03 13:12:44 +02:00
powerpc PPC KVM update for 5.9 2020-08-09 13:24:02 -04:00
process docs: submitting-patches: use :doc: for references 2020-09-10 10:50:01 -06:00
riscv
s390 It's been a busy cycle for documentation - hopefully the busiest for a 2020-08-04 22:47:54 -07:00
scheduler docs: scheduler: fix the directory name on two files 2020-09-10 10:45:45 -06:00
scsi scsi: advansys: docs: Eliminate duplicated word 2020-07-08 01:32:11 -04:00
security Documentation: remove current_security() reference 2020-09-09 11:33:59 -06:00
sh docs: sh: convert register-banks.txt to ReST 2020-06-19 14:10:13 -06:00
sound ASoC: Updates for v5.9 2020-08-03 14:41:43 +02:00
sparc
sphinx docs: Add automatic cross-reference for documentation pages 2020-09-16 11:09:51 -06:00
sphinx-static
spi SPI SUBSYSTEM: Replace HTTP links with HTTPS ones 2020-07-09 22:41:11 +01:00
staging remoteproc updates for v5.9 2020-08-11 11:17:45 -07:00
target doc: don't use deprecated "---help---" markers in target docs 2020-06-13 13:32:40 -07:00
timers docs: timers: drop documentation about LB_BIAS 2020-07-23 14:32:44 -06:00
trace docs: trace: ring-buffer-design.rst: use the new SPDX tag 2020-09-24 11:07:44 -06:00
translations docs: filesystems: replace to_dev() with kobj_to_dev() 2020-09-09 11:35:51 -06:00
usb USB: Replace HTTP links with HTTPS ones 2020-07-21 13:41:57 +02:00
userspace-api remoteproc updates for v5.9 2020-08-11 11:17:45 -07:00
virt docs: replace the old User Mode Linux HowTo with a new one 2020-09-24 10:53:44 -06:00
vm mm/doc: add usage description for migrate_vma_*() 2020-09-16 12:19:51 -06:00
w1
watchdog watchdog: add support for adjusting last known HW keepalive time 2020-08-05 18:43:02 +02:00
x86 It's been a busy cycle for documentation - hopefully the busiest for a 2020-08-04 22:47:54 -07:00
xtensa
.gitignore
COPYING-logo
Changes
CodingStyle
Kconfig
Makefile
SubmittingPatches
asm-annotations.rst
atomic_bitops.txt
atomic_t.txt Documentation/litmus-tests/atomic: Add a test for smp_mb__after_atomic() 2020-06-29 12:05:18 -07:00
conf.py Make the docs build "work" with Sphinx 3.x 2020-09-04 10:13:45 -06:00
docutils.conf
dontdiff Documentation: dontdiff: Add zstd compressed files 2020-07-31 11:51:10 +02:00
index.rst docs: index.rst: Add watch_queue 2020-07-23 14:13:23 -06:00
logo.gif
memory-barriers.txt docs/memory-barriers.txt: Fix references for DMA*.txt files 2020-08-31 16:14:44 -06:00
watch_queue.rst docs: watch_queue: fix some warnings 2020-09-10 10:48:56 -06:00