[PATCH bpf-next] bpf, docs: BPF Iterator Document

Anton Protopopov posted 1 patch 2 years, 2 months ago
Documentation/bpf/bpf_iterators.rst | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
[PATCH bpf-next] bpf, docs: BPF Iterator Document
Posted by Anton Protopopov 2 years, 2 months ago
Fix the description of the seq_info field of the bpf_iter_reg structure which
was wrong due to an accidental copy/paste of the previous field's description.

Fixes: 8972e18a439d ("bpf, docs: BPF Iterator Document")
Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
---
 Documentation/bpf/bpf_iterators.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/Documentation/bpf/bpf_iterators.rst b/Documentation/bpf/bpf_iterators.rst
index 6d7770793fab..07433915aa41 100644
--- a/Documentation/bpf/bpf_iterators.rst
+++ b/Documentation/bpf/bpf_iterators.rst
@@ -238,11 +238,8 @@ The following is the breakdown for each field in struct ``bpf_iter_reg``.
        that the kernel function cond_resched() is called to avoid other kernel
        subsystem (e.g., rcu) misbehaving.
    * - seq_info
-     - Specifies certain action requests in the kernel BPF iterator
-       infrastructure. Currently, only BPF_ITER_RESCHED is supported. This means
-       that the kernel function cond_resched() is called to avoid other kernel
-       subsystem (e.g., rcu) misbehaving.
-
+     - Specifies the set of seq operations for the BPF iterator and helpers to
+       initialize/free the private data for the corresponding ``seq_file``.
 
 `Click here
 <https://lore.kernel.org/bpf/20210212183107.50963-2-songliubraving@fb.com/>`_
-- 
2.34.1
Re: [PATCH bpf-next] bpf, docs: BPF Iterator Document
Posted by patchwork-bot+netdevbpf@kernel.org 2 years, 2 months ago
Hello:

This patch was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:

On Thu, 22 Jun 2023 09:54:07 +0000 you wrote:
> Fix the description of the seq_info field of the bpf_iter_reg structure which
> was wrong due to an accidental copy/paste of the previous field's description.
> 
> Fixes: 8972e18a439d ("bpf, docs: BPF Iterator Document")
> Signed-off-by: Anton Protopopov <aspsk@isovalent.com>
> ---
>  Documentation/bpf/bpf_iterators.rst | 7 ++-----
>  1 file changed, 2 insertions(+), 5 deletions(-)

Here is the summary with links:
  - [bpf-next] bpf, docs: BPF Iterator Document
    https://git.kernel.org/bpf/bpf-next/c/2404dd01b534

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
Re: [PATCH bpf-next] bpf, docs: BPF Iterator Document
Posted by Yonghong Song 2 years, 2 months ago

On 6/22/23 2:54 AM, Anton Protopopov wrote:
> Fix the description of the seq_info field of the bpf_iter_reg structure which
> was wrong due to an accidental copy/paste of the previous field's description.
> 
> Fixes: 8972e18a439d ("bpf, docs: BPF Iterator Document")
> Signed-off-by: Anton Protopopov <aspsk@isovalent.com>

Thanks for fixing the bpf_iter documentation!

Acked-by: Yonghong Song <yhs@fb.com>