[PATCH bpf-next] docs: bpf: fix bullet point formatting warning

[PATCH bpf-next] docs: bpf: fix bullet point formatting warning

[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.

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>
---
Hello, please let me know if you have any comments, thanks!

---
 Documentation/bpf/bpf_iterators.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/bpf/bpf_iterators.rst b/Documentation/bpf/bpf_iterators.rst
index 8f0a4a91b77a..189e3ec1c6c8 100644
--- a/Documentation/bpf/bpf_iterators.rst
+++ b/Documentation/bpf/bpf_iterators.rst
@@ -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

Re: [PATCH bpf-next] docs: bpf: fix bullet point formatting warning

[Andrii Nakryiko]

On Mon, May 12, 2025 at 6:59 PM Khaled Elnaggar
<khaledelnaggarlinux@gmail.com> 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]
>
> Fixes: 7220eabff8cb ("bpf, docs: document open-coded BPF iterators")
> Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
> ---
> Hello, please let me know if you have any comments, thanks!

Thanks for the fix, it makes sense. Applied to bpf-next.

>
> ---
>  Documentation/bpf/bpf_iterators.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/bpf/bpf_iterators.rst b/Documentation/bpf/bpf_iterators.rst
> index 8f0a4a91b77a..189e3ec1c6c8 100644
> --- a/Documentation/bpf/bpf_iterators.rst
> +++ b/Documentation/bpf/bpf_iterators.rst
> @@ -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
>

Re: [PATCH bpf-next] docs: bpf: fix bullet point formatting warning

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Andrii Nakryiko <andrii@kernel.org>:

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html