iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
linux/Documentation/bpf
History
David Vernet 4d496be9ca bpf,docs: Create new standardization subdirectory 
The BPF standardization effort is actively underway with the IETF. As
described in the BPF Working Group (WG) charter in [0], there are a
number of proposed documents, some informational and some proposed
standards, that will be drafted as part of the standardization effort.

[0]: https://datatracker.ietf.org/wg/bpf/about/

Though the specific documents that will formally be standardized will
exist as Internet Drafts (I-D) and WG documents in the BPF WG
datatracker page, the source of truth from where those documents will be
generated will reside in the kernel documentation tree (originating in
the bpf-next tree).

Because these documents will be used to generate the I-D and WG
documents which will be standardized with the IETF, they are a bit
special as far as kernel-tree documentation goes:

- They will be dual licensed with LGPL-2.1 OR BSD-2-Clause
- IETF I-D and WG documents (the documents which will actually be
  standardized) will be auto-generated from these documents.

In order to keep things clearly organized in the BPF documentation tree,
and to make it abundantly clear where standards-related documentation
needs to go, we should move standards-relevant documents into a separate
standardization/ subdirectory.

Signed-off-by: David Vernet <void@manifault.com>
Link: https://lore.kernel.org/r/20230710183027.15132-1-void@manifault.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
2023-07-10 18:12:50 -07:00
..
libbpf
bpf, docs: Libbpf overview documentation
2023-03-18 10:17:39 -07:00
standardization
bpf,docs: Create new standardization subdirectory
2023-07-10 18:12:50 -07:00
bpf_design_QA.rst
bpf: Rename __kptr_ref -> __kptr and __kptr -> __kptr_untrusted.
2023-03-03 17:42:20 +01: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, docs: BPF Iterator Document
2023-06-22 19:44:22 +02:00
bpf_licensing.rst
bpf: Document BPF licensing.
2021-09-22 23:13:13 +02:00
bpf_prog_run.rst
Documentation/bpf: Add documentation for BPF_PROG_RUN
2022-03-09 14:19:22 -08:00
btf.rst
bpf: Replace deprecated -target with --target= for Clang
2023-06-29 15:46:17 +02:00
clang-notes.rst
bpf, docs: Explain helper functions
2023-03-10 13:02:00 -08:00
classic_vs_extended.rst
bpf, docs: Split the comparism to classic BPF from instruction-set.rst
2021-12-30 16:31:44 -08:00
cpumasks.rst
bpf/docs: Update documentation for new cpumask kfuncs
2023-06-12 15:09:11 -07:00
drgn.rst
bpf: Document bpf_inspect drgn tool
2020-03-26 00:08:36 +01:00
faq.rst
bpf, docs: Fix ordering of bpf documentation
2021-11-17 23:24:01 +01:00
graph_ds_impl.rst
Documentation: bpf: Add missing line break separator in node_data struct code block
2023-02-15 08:43:51 -08:00
helpers.rst
bpf, docs: Fix ordering of bpf documentation
2021-11-17 23:24:01 +01:00
index.rst
bpf,docs: Create new standardization subdirectory
2023-07-10 18:12:50 -07:00
kfuncs.rst
bpf, docs: Document existing macros instead of deprecated
2023-06-22 19:47:32 +02:00
llvm_reloc.rst
bpf: Replace deprecated -target with --target= for Clang
2023-06-29 15:46:17 +02:00
map_array.rst
docs/bpf: Fix sphinx warnings in BPF map docs
2022-11-24 01:05:04 +01:00
map_bloom_filter.rst
docs/bpf: Document BPF_MAP_TYPE_BLOOM_FILTER
2022-11-23 22:47:32 +01:00
map_cgroup_storage.rst
Remove duplicate words inside documentation
2022-09-27 13:21:43 -06:00
map_cgrp_storage.rst
docs/bpf: Add documentation for new cgroup local storage
2022-10-25 23:19:20 -07:00
map_cpumap.rst
docs/bpf: Fix sphinx warnings for cpumap
2022-11-23 22:38:53 +01:00
map_devmap.rst
docs/bpf: Fix sphinx warnings for devmap
2022-11-23 22:40:27 +01:00
map_hash.rst
docs/bpf: Add LRU internals description and graph
2023-04-27 14:20:44 +02:00
map_lpm_trie.rst
docs/bpf: Fix sphinx warnings in BPF map docs
2022-11-24 01:05:04 +01:00
map_lru_hash_update.dot
docs/bpf: Add LRU internals description and graph
2023-04-27 14:20:44 +02:00
map_of_maps.rst
docs/bpf: Fix sphinx warnings in BPF map docs
2022-11-24 01:05:04 +01:00
map_queue_stack.rst
docs/bpf: Fix sphinx warnings in BPF map docs
2022-11-24 01:05:04 +01:00
map_sk_storage.rst
docs/bpf: Reword docs for BPF_MAP_TYPE_SK_STORAGE
2022-12-14 18:35:41 +01:00
map_sockmap.rst
sock: Remove ->sendpage*() in favour of sendmsg(MSG_SPLICE_PAGES)
2023-06-24 15:50:13 -07:00
map_xskmap.rst
Documentation: bpf: correct spelling
2023-01-28 12:22:20 -08:00
maps.rst
bpf, docs: Fix final bpf docs build failure
2023-03-02 22:36:10 -08:00
other.rst
bpf, documentation: Add graph documentation for non-owning refs
2023-02-13 19:40:53 -08:00
prog_cgroup_sockopt.rst
bpf: Document EFAULT changes for sockopt
2023-05-13 16:55:46 -07:00
prog_cgroup_sysctl.rst
bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL
2019-04-18 16:05:36 -07:00
prog_flow_dissector.rst
bpf/flow_dissector: add mode to enforce global BPF flow dissector
2019-10-07 20:16:33 -07:00
prog_lsm.rst
lsm: move hook comments docs to security/security.c
2023-04-28 11:58:34 -04:00
prog_sk_lookup.rst
bpf: sk_lookup: Add user documentation
2020-08-24 14:46:50 -07:00
programs.rst
docs/bpf: Add table of BPF program types to libbpf docs
2022-11-23 13:31:20 -08:00
redirect.rst
bpf, docs: DEVMAPs and XDP_REDIRECT
2022-11-18 23:16:31 +01:00
ringbuf.rst
Documentation: bpf: correct spelling
2023-01-28 12:22:20 -08:00
s390.rst
bpf: Add s390 testing documentation
2019-10-30 16:25:31 +01:00
syscall_api.rst
bpf, docs: Fix ordering of bpf documentation
2021-11-17 23:24:01 +01:00
test_debug.rst
bpf, docs: Fix ordering of bpf documentation
2021-11-17 23:24:01 +01:00
verifier.rst
docs/bpf: Add description of register liveness tracking algorithm
2023-02-02 20:21:59 -08:00