[bpf-next,v10,0/1] Document BPF_MAP_TYPE_ARRAY

Message

Donald Hunter Nov. 9, 2022, 5:46 p.m. UTC

Add documentation for BPF_MAP_TYPE_ARRAY and BPF_MAP_TYPE_PERCPU_ARRAY
variant, including kernel version introduced, usage and examples.

v9->v10:
- Add missing Reviewed-by tag

v8->v9:
- Add "Kernel BPF" heading suggested by Jesper Brouer
- Tidy up wording to clarify BPF vs userspace APIs

v7->v8:
- Fix alignment wording reported by Alexei Starovoitov
- Avoid deprecated functions, reported by Alexei Starovoitov
- Fix code sample formatting, reported by Alexei Starovoitov

v6->v7:
- Remove 2^32 reference and reword paragraph
  reported by Jiri Olsa and Daniel Borkmann

v5->v6:
- Rework sample code into individual snippets
- Grammar mods suggested by Bagas Sanjaja

v4->v5:
- Use formatting consistent with *_TYPE_HASH docs
- Dropped cgroup doc patch from this set
- Fix grammar and typos reported by Bagas Sanjaya
- Fix typo and version reported by Donald Hunter
- Update examples to be libbpf v1 compatible

v3->v4:
- fix doctest failure due to missing newline

v2->v3:
- wrap text to 80 chars and add newline at end of file

v1->v2:
- point to selftests for functional examples
- update examples to follow kernel style
- add docs for BPF_F_MMAPABLE

Dave Tucker (1):
  bpf, docs: document BPF_MAP_TYPE_ARRAY

 Documentation/bpf/map_array.rst | 250 ++++++++++++++++++++++++++++++++
 1 file changed, 250 insertions(+)
 create mode 100644 Documentation/bpf/map_array.rst

Comments

[e-mail] Nov. 11, 2022, 7:40 p.m. UTC | #1

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Andrii Nakryiko <[e-mail]>:

On Wed,  9 Nov 2022 17:46:03 +0000 you wrote:
> Add documentation for BPF_MAP_TYPE_ARRAY and BPF_MAP_TYPE_PERCPU_ARRAY
> variant, including kernel version introduced, usage and examples.
> 
> v9->v10:
> - Add missing Reviewed-by tag
> 
> v8->v9:
> - Add "Kernel BPF" heading suggested by Jesper Brouer
> - Tidy up wording to clarify BPF vs userspace APIs
> 
> [...]

Here is the summary with links:
  - [bpf-next,v10,1/1] bpf, docs: document BPF_MAP_TYPE_ARRAY
    https://git.kernel.org/bpf/bpf-next/c/1cfa97b30c5a

You are awesome, thank you!