From: Donald Hunter <donald.hunter@gmail.com>
To: bpf@vger.kernel.org, linux-doc@vger.kernel.org
Cc: Alexei Starovoitov <ast@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
Andrii Nakryiko <andrii@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Donald Hunter <donald.hunter@gmail.com>
Subject: [PATCH bpf-next v10 0/1] Document BPF_MAP_TYPE_ARRAY
Date: Wed, 9 Nov 2022 17:46:03 +0000 [thread overview]
Message-ID: <20221109174604.31673-1-donald.hunter@gmail.com> (raw)
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
--
2.35.1
next reply other threads:[~2022-11-09 17:46 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-09 17:46 Donald Hunter [this message]
2022-11-09 17:46 ` [PATCH bpf-next v10 1/1] bpf, docs: document BPF_MAP_TYPE_ARRAY Donald Hunter
2022-11-11 1:52 ` Bagas Sanjaya
2022-11-11 19:39 ` Andrii Nakryiko
2022-11-14 10:18 ` Donald Hunter
2022-11-14 19:44 ` Andrii Nakryiko
2022-11-11 19:40 ` [PATCH bpf-next v10 0/1] Document BPF_MAP_TYPE_ARRAY patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221109174604.31673-1-donald.hunter@gmail.com \
--to=donald.hunter@gmail.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=linux-doc@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).