docs: bpf: fix bullet point formatting warning
Subsystems (2)
PATCH 1/1 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]
---
Hello, please let me know if you have any comments, thanks!
--- Documentation/bpf/bpf_iterators.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/bpf/bpf_iterators.rst +5 -5
@@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type>` as the very first argument. Additionally: - Constructor, i.e., `bpf_iter_<type>_new()`, can have arbitrary extra - number of arguments. Return type is not enforced either. + number of arguments. Return type is not enforced either. - Next method, i.e., `bpf_iter_<type>_next()`, has to return a pointer - type and should have exactly one argument: `struct bpf_iter_<type> *` - (const/volatile/restrict and typedefs are ignored). + type and should have exactly one argument: `struct bpf_iter_<type> *` + (const/volatile/restrict and typedefs are ignored). - Destructor, i.e., `bpf_iter_<type>_destroy()`, should return void and - should have exactly one argument, similar to the next method. + should have exactly one argument, similar to the next method. - `struct bpf_iter_<type>` size is enforced to be positive and - a multiple of 8 bytes (to fit stack slots correctly). + a multiple of 8 bytes (to fit stack slots correctly). Such strictness and consistency allows to build generic helpers abstracting important, but boilerplate, details to be able to use open-coded iterators
--
2.47.2
Quoted 7 lines · Khaled Elnaggar
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.
Quoted 7 lines
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 <[email protected]>---
Hello, please let me know if you have any comments, thanks!
Thanks for the fix, it makes sense. Applied to bpf-next.
Quoted 32 lines
--- Documentation/bpf/bpf_iterators.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)Documentation/bpf/bpf_iterators.rst +5
-6@@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type>` as the very first argument. Additionally: - Constructor, i.e., `bpf_iter_<type>_new()`, can have arbitrary extra - number of arguments. Return type is not enforced either. + number of arguments. Return type is not enforced either. - Next method, i.e., `bpf_iter_<type>_next()`, has to return a pointer - type and should have exactly one argument: `struct bpf_iter_<type> *` - (const/volatile/restrict and typedefs are ignored). + type and should have exactly one argument: `struct bpf_iter_<type> *` + (const/volatile/restrict and typedefs are ignored). - Destructor, i.e., `bpf_iter_<type>_destroy()`, should return void and - should have exactly one argument, similar to the next method. + should have exactly one argument, similar to the next method. - `struct bpf_iter_<type>` size is enforced to be positive and - a multiple of 8 bytes (to fit stack slots correctly). + a multiple of 8 bytes (to fit stack slots correctly). Such strictness and consistency allows to build generic helpers abstracting important, but boilerplate, details to be able to use open-coded iterators --2.47.2
This patch was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Hello:
This patch was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Quoted 10 lines · On Tue, 13 May 2025 04:58:59 +0300 you wrote:
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][...]
Here is the summary with links:
- [bpf-next] docs: bpf: fix bullet point formatting warning
https://git.kernel.org/bpf/bpf-next/c/79af71c5fe44
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html