Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: bpf: Fix bullet point formatting warning

Fix indentation for a bullet list item in bpf_iterators.rst.
According to reStructuredText rules, bullet list item bodies must be
consistently indented relative to the bullet. The indentation of the
first line after the bullet determines the alignment for the rest of
the item body.

Reported by smatch:
/linux/Documentation/bpf/bpf_iterators.rst:55: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils]

Fixes: 7220eabff8cb ("bpf, docs: document open-coded BPF iterators")
Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20250513015901.475207-1-khaledelnaggarlinux@gmail.com

authored by

Khaled Elnaggar and committed by
Andrii Nakryiko
79af71c5 f4efc73b

+5 -5
+5 -5
Documentation/bpf/bpf_iterators.rst
··· 52 52 53 53 Additionally: 54 54 - Constructor, i.e., `bpf_iter_<type>_new()`, can have arbitrary extra 55 - number of arguments. Return type is not enforced either. 55 + number of arguments. Return type is not enforced either. 56 56 - Next method, i.e., `bpf_iter_<type>_next()`, has to return a pointer 57 - type and should have exactly one argument: `struct bpf_iter_<type> *` 58 - (const/volatile/restrict and typedefs are ignored). 57 + type and should have exactly one argument: `struct bpf_iter_<type> *` 58 + (const/volatile/restrict and typedefs are ignored). 59 59 - Destructor, i.e., `bpf_iter_<type>_destroy()`, should return void and 60 - should have exactly one argument, similar to the next method. 60 + should have exactly one argument, similar to the next method. 61 61 - `struct bpf_iter_<type>` size is enforced to be positive and 62 - a multiple of 8 bytes (to fit stack slots correctly). 62 + a multiple of 8 bytes (to fit stack slots correctly). 63 63 64 64 Such strictness and consistency allows to build generic helpers abstracting 65 65 important, but boilerplate, details to be able to use open-coded iterators