[PATCH] bpf, docs: add indentation to make the bullet list work

[PATCH] bpf, docs: add indentation to make the bullet list work

[Randy Dunlap]

Fix a docs build warning and make the formatted output render
correctly as a list.

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: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrii Nakryiko <andrii@kernel.org>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: bpf@vger.kernel.org
---
 Documentation/bpf/bpf_iterators.rst |   10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

--- linux-next-20250516.orig/Documentation/bpf/bpf_iterators.rst
+++ linux-next-20250516/Documentation/bpf/bpf_iterators.rst
@@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type
 
 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

Re: [PATCH] bpf, docs: add indentation to make the bullet list work

[Alexei Starovoitov]

On Mon, May 19, 2025 at 1:57 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Fix a docs build warning and make the formatted output render
> correctly as a list.
>
> 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: Randy Dunlap <rdunlap@infradead.org>
> Cc: Andrii Nakryiko <andrii@kernel.org>
> Cc: Alexei Starovoitov <ast@kernel.org>
> Cc: Daniel Borkmann <daniel@iogearbox.net>
> Cc: bpf@vger.kernel.org
> ---
>  Documentation/bpf/bpf_iterators.rst |   10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> --- linux-next-20250516.orig/Documentation/bpf/bpf_iterators.rst
> +++ linux-next-20250516/Documentation/bpf/bpf_iterators.rst
> @@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type
>
>  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.

This was fixed a week ago in
commit 79af71c5fe44 ("docs: bpf: Fix bullet point formatting warning")