Skip to content

Commit 79af71c

Browse files
Khaled Elnaggaranakryiko
authored andcommitted
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: 7220eab ("bpf, docs: document open-coded BPF iterators") Signed-off-by: Khaled Elnaggar <[email protected]> Signed-off-by: Andrii Nakryiko <[email protected]> Link: https://lore.kernel.org/bpf/[email protected]
1 parent f4efc73 commit 79af71c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/bpf/bpf_iterators.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type>` as the very first argument.
5252

5353
Additionally:
5454
- 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.
5656
- 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).
5959
- 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.
6161
- `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).
6363

6464
Such strictness and consistency allows to build generic helpers abstracting
6565
important, but boilerplate, details to be able to use open-coded iterators

0 commit comments

Comments
 (0)