bpf, docs: document open-coded BPF iterators
authorAndrii Nakryiko <andrii@kernel.org>
Fri, 9 May 2025 18:03:50 +0000 (11:03 -0700)
committerAlexei Starovoitov <ast@kernel.org>
Sat, 10 May 2025 05:49:15 +0000 (22:49 -0700)
commit7220eabff8cb4af3b93cd021aa853b9f5df2923f
treeb9182a62a391e179ed2876fedf41d8f185e4b1c4
parentc8ce7db0ca83745a6b439c8b22cba49b7fb095e2
bpf, docs: document open-coded BPF iterators

Extract BPF open-coded iterators documentation spread out across a few
original commit messages ([0], [1]) into a dedicated doc section under
Documentation/bpf/bpf_iterators.rst. Also make explicit expectation that
BPF iterator program type should be accompanied by a corresponding
open-coded BPF iterator implementation, going forward.

  [0] https://lore.kernel.org/all/20230308184121.1165081-3-andrii@kernel.org/
  [1] https://lore.kernel.org/all/20230308184121.1165081-4-andrii@kernel.org/

Acked-by: Kumar Kartikeya Dwivedi <memxor@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/r/20250509180350.2604946-1-andrii@kernel.org
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/bpf_iterators.rst