OSDN Git Service

bpf,docs: Create new standardization subdirectory
authorDavid Vernet <void@manifault.com>
Mon, 10 Jul 2023 18:30:27 +0000 (13:30 -0500)
committerAlexei Starovoitov <ast@kernel.org>
Tue, 11 Jul 2023 01:12:50 +0000 (18:12 -0700)
commit4d496be9ca05d22dbbbba78368ac4bb05bcc67f2
tree0c7ba7b351ebc259d3cbb320d1d6754ec9fa5da4
parent19f4b532346219bb60a515c3c9ba21482e8357ee
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>
Documentation/bpf/index.rst
Documentation/bpf/standardization/index.rst [new file with mode: 0644]
Documentation/bpf/standardization/instruction-set.rst [moved from Documentation/bpf/instruction-set.rst with 100% similarity]
Documentation/bpf/standardization/linux-notes.rst [moved from Documentation/bpf/linux-notes.rst with 96% similarity]
MAINTAINERS