|
|
Subscribe / Log in / New account

bpf, docs: Document BPF_MAP_TYPE_ARRAY

From:  Dave Tucker <dave-AT-dtucker.co.uk>
To:  bpf-AT-vger.kernel.org
Subject:  [PATCH v4 bpf-next 0/2] bpf, docs: Document BPF_MAP_TYPE_ARRAY
Date:  Thu, 30 Jun 2022 13:04:07 +0100
Message-ID:  <cover.1656590177.git.dave@dtucker.co.uk>
Cc:  corbet-AT-lwn.net, ast-AT-kernel.org, daniel-AT-iogearbox.net, andrii-AT-kernel.org, kafai-AT-fb.com, songliubraving-AT-fb.com, john.fastabend-AT-gmail.com, kpsingh-AT-kernel.org, linux-doc-AT-vger.kernel.org, Dave Tucker <dave-AT-dtucker.co.uk>
Archive-link:  Article

This series is the beginning of my attempt to improve the BPF map and
program type documentation. It expands the template from
map_cgroup_storage to include the kernel version it was introduced.
I then used this template to document BPF_MAP_TYPE_ARRAY and
BPF_MAP_TYPE_PERCPU_ARRAY

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 (2):
  bpf, docs: add kernel version to map_cgroup_storage
  bpf, docs: document BPF_MAP_TYPE_ARRAY

 Documentation/bpf/map_array.rst          | 183 +++++++++++++++++++++++
 Documentation/bpf/map_cgroup_storage.rst |   2 +
 2 files changed, 185 insertions(+)
 create mode 100644 Documentation/bpf/map_array.rst

-- 
2.37.0



Copyright © 2022, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds