]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/commit - Documentation/bpf/index.rst
bpf, doc: add basic README.rst file
authorJesper Dangaard Brouer <brouer@redhat.com>
Mon, 14 May 2018 13:42:12 +0000 (15:42 +0200)
committerAlexei Starovoitov <ast@kernel.org>
Tue, 15 May 2018 06:02:58 +0000 (23:02 -0700)
commit4712c1b203dd04d9b0f3139000bc4bfbb94b0c05
treea84ec9de3a7da681cb08256e67a1df054f2258a4
parent1d827879fc694a177875835d5bb06f8bebecca26
bpf, doc: add basic README.rst file

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 [new file with mode: 0644]