libbpf: Document API and ABI conventions
authorAndrey Ignatov <rdna@fb.com>
Sat, 24 Nov 2018 00:44:35 +0000 (16:44 -0800)
committerAlexei Starovoitov <ast@kernel.org>
Tue, 27 Nov 2018 02:57:14 +0000 (18:57 -0800)
commit76d1b894c5155dbc44d24f6df2e0da3726d54bbd
treee1c8d11ecef50d45f8c976013ae01062a014ae37
parent306b267cb3c4c2a3d12138041fed10478804da82
libbpf: Document API and ABI conventions

Document API and ABI for libbpf: naming convention, symbol visibility,
ABI versioning.

This is just a starting point. Documentation can be significantly
extended in the future to cover more topics.

ABI versioning section touches only a few basic points with a link to
more comprehensive documentation from Ulrich Drepper. This section can
be extended in the future when there is better understanding what works
well and what not so well in libbpf development process and production
usage.

Signed-off-by: Andrey Ignatov <rdna@fb.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
tools/lib/bpf/README.rst [new file with mode: 0644]