1
linux/Documentation/bpf
Dave Thaler 04efaebd72 bpf, docs: Address comments from IETF Area Directors
This patch does the following to address IETF feedback:

* Remove mention of "program type" and reference future
  docs (and mention platform-specific docs exist) for
  helper functions and BTF. Addresses Roman Danyliw's
  comments based on GENART review from Ines Robles [0].

* Add reference for endianness as requested by John
  Scudder [1].

* Added bit numbers to top of 32-bit wide format diagrams
  as requested by Paul Wouters [2].

* Added more text about why BPF doesn't stand for anything, based
  on text from ebpf.io [3], as requested by Eric Vyncke and
  Gunter Van de Velde [4].

* Replaced "htobe16" (and similar) and the direction-specific
  description with just "be16" (and similar) and a direction-agnostic
  description, to match the direction-agnostic description in
  the Byteswap Instructions section. Based on feedback from Eric
  Vyncke [5].

[0] https://mailarchive.ietf.org/arch/msg/bpf/DvDgDWOiwk05OyNlWlAmELZFPlM/

[1] https://mailarchive.ietf.org/arch/msg/bpf/eKNXpU4jCLjsbZDSw8LjI29M3tM/

[2] https://mailarchive.ietf.org/arch/msg/bpf/hGk8HkYxeZTpdu9qW_MvbGKj7WU/

[3] https://ebpf.io/what-is-ebpf/#what-do-ebpf-and-bpf-stand-for

[4] https://mailarchive.ietf.org/arch/msg/bpf/i93lzdN3ewnzzS_JMbinCIYxAIU/

[5] https://mailarchive.ietf.org/arch/msg/bpf/KBWXbMeDcSrq4vsKR_KkBbV6hI4/

Acked-by: David Vernet <void@manifault.com>
Signed-off-by: Dave Thaler <dthaler1968@googlemail.com>
Link: https://lore.kernel.org/r/20240623150453.10613-1-dthaler1968@gmail.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
2024-06-23 09:10:26 -07:00
..
libbpf libbpf: Configure log verbosity with env variable 2024-05-28 16:25:06 -07:00
standardization bpf, docs: Address comments from IETF Area Directors 2024-06-23 09:10:26 -07:00
bpf_design_QA.rst docs/bpf: Add documentation for new instructions 2023-07-27 18:54:17 -07:00
bpf_devel_QA.rst bpf: Replace deprecated -target with --target= for Clang 2023-06-29 15:46:17 +02:00
bpf_iterators.rst
bpf_licensing.rst
bpf_prog_run.rst
btf.rst docs: automarkup: linkify git revs 2023-11-17 13:13:24 -07:00
clang-notes.rst
classic_vs_extended.rst
cpumasks.rst bpf: Add bpf_cpumask_weight() kfunc 2023-12-09 21:37:33 -08:00
drgn.rst
faq.rst
fs_kfuncs.rst Documentation/bpf: Add documentation for filesystem kfuncs 2023-12-01 16:21:03 -08:00
graph_ds_impl.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
helpers.rst
index.rst Documentation/bpf: Add documentation for filesystem kfuncs 2023-12-01 16:21:03 -08:00
kfuncs.rst bpf: treewide: Annotate BPF kfuncs in BTF 2024-01-31 20:40:56 -08:00
linux-notes.rst bpf, docs: Move linux-notes.rst to root bpf docs tree 2023-08-30 16:35:44 +02:00
llvm_reloc.rst docs/bpf: Fix "file doesn't exist" warnings in {llvm_reloc,btf}.rst 2023-09-01 15:56:48 +02:00
map_array.rst
map_bloom_filter.rst
map_cgroup_storage.rst
map_cgrp_storage.rst
map_cpumap.rst
map_devmap.rst
map_hash.rst
map_lpm_trie.rst bpf: Replace bpf_lpm_trie_key 0-length array with flexible array 2024-02-29 22:52:43 +01:00
map_lru_hash_update.dot
map_of_maps.rst
map_queue_stack.rst
map_sk_storage.rst
map_sockmap.rst
map_xskmap.rst
maps.rst
other.rst
prog_cgroup_sockopt.rst
prog_cgroup_sysctl.rst
prog_flow_dissector.rst docs/bpf: update out-of-date doc in BPF flow dissector 2023-09-13 14:22:57 -07:00
prog_lsm.rst
prog_sk_lookup.rst
programs.rst
redirect.rst
ringbuf.rst
s390.rst
syscall_api.rst
test_debug.rst
verifier.rst docs/bpf: Fix an incorrect statement in verifier.rst 2024-01-23 14:40:23 -08:00