GNU Linux-libre 6.9.1-gnu
[releases.git] / Documentation / bpf / libbpf / index.rst
1 .. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
2
3 .. _libbpf:
4
5 ======
6 libbpf
7 ======
8
9 If you are looking to develop BPF applications using the libbpf library, this
10 directory contains important documentation that you should read.
11
12 To get started, it is recommended to begin with the :doc:`libbpf Overview
13 <libbpf_overview>` document, which provides a high-level understanding of the
14 libbpf APIs and their usage. This will give you a solid foundation to start
15 exploring and utilizing the various features of libbpf to develop your BPF
16 applications.
17
18 .. toctree::
19    :maxdepth: 1
20
21    libbpf_overview
22    API Documentation <https://libbpf.readthedocs.io/en/latest/api.html>
23    program_types
24    libbpf_naming_convention
25    libbpf_build
26
27
28 All general BPF questions, including kernel functionality, libbpf APIs and their
29 application, should be sent to bpf@vger.kernel.org mailing list.  You can
30 `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the mailing list
31 search its `archive <https://lore.kernel.org/bpf/>`_.  Please search the archive
32 before asking new questions. It may be that this was already addressed or
33 answered before.