bpf, doc: add basic README.rst file (4712c1b2) · Commits · 戴 / test

A README.rst file in a directory have special meaning for sites like github, which auto renders the contents. Plus search engines like Google also index these README.rst files. Auto rendering allow us to use links, for (re)directing eBPF users to other places where docs live. The end-goal would be to direct users towards https://www.kernel.org/doc/html/latest but we haven't written the full docs yet, so we start out small and take this incrementally. This directory itself contains some useful docs, which can be linked to from the README.rst file (verified this works for github). Signed-off-by:

Jesper Dangaard Brouer <brouer@redhat.com> Signed-off-by:

Alexei Starovoitov <ast@kernel.org>

Documentation/bpf/README.rst

0 → 100644

+36 −0

Original line number	Diff line number	Diff line
		=================
		BPF documentation
		=================

		This directory contains documentation for the BPF (Berkeley Packet
		Filter) facility, with a focus on the extended BPF version (eBPF).

		This kernel side documentation is still work in progress. The main
		textual documentation is (for historical reasons) described in
		`Documentation/networking/filter.txt`_, which describe both classical
		and extended BPF instruction-set.
		The Cilium project also maintains a `BPF and XDP Reference Guide`_
		that goes into great technical depth about the BPF Architecture.

		The primary info for the bpf syscall is available in the `man-pages`_
		for `bpf(2)`_.



		Frequently asked questions (FAQ)
		================================

		Two sets of Questions and Answers (Q&A) are maintained.

		* QA for common questions about BPF see: bpf_design_QA_

		* QA for developers interacting with BPF subsystem: bpf_devel_QA_


		.. Links:
		.. _bpf_design_QA: bpf_design_QA.txt
		.. _bpf_devel_QA: bpf_devel_QA.txt
		.. _Documentation/networking/filter.txt: ../networking/filter.txt
		.. _man-pages: https://www.kernel.org/doc/man-pages/
		.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
		.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/

Admin message