xref: /aosp_15_r20/external/libbpf/docs/index.rst (revision f7c14bbac8cf49633f2740db462ea43457973ec4)
1*f7c14bbaSAndroid Build Coastguard Worker.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
2*f7c14bbaSAndroid Build Coastguard Worker
3*f7c14bbaSAndroid Build Coastguard Worker.. _libbpf:
4*f7c14bbaSAndroid Build Coastguard Worker
5*f7c14bbaSAndroid Build Coastguard Worker======
6*f7c14bbaSAndroid Build Coastguard Workerlibbpf
7*f7c14bbaSAndroid Build Coastguard Worker======
8*f7c14bbaSAndroid Build Coastguard Worker
9*f7c14bbaSAndroid Build Coastguard WorkerIf you are looking to develop BPF applications using the libbpf library, this
10*f7c14bbaSAndroid Build Coastguard Workerdirectory contains important documentation that you should read.
11*f7c14bbaSAndroid Build Coastguard Worker
12*f7c14bbaSAndroid Build Coastguard WorkerTo get started, it is recommended to begin with the :doc:`libbpf Overview
13*f7c14bbaSAndroid Build Coastguard Worker<libbpf_overview>` document, which provides a high-level understanding of the
14*f7c14bbaSAndroid Build Coastguard Workerlibbpf APIs and their usage. This will give you a solid foundation to start
15*f7c14bbaSAndroid Build Coastguard Workerexploring and utilizing the various features of libbpf to develop your BPF
16*f7c14bbaSAndroid Build Coastguard Workerapplications.
17*f7c14bbaSAndroid Build Coastguard Worker
18*f7c14bbaSAndroid Build Coastguard Worker.. toctree::
19*f7c14bbaSAndroid Build Coastguard Worker   :maxdepth: 1
20*f7c14bbaSAndroid Build Coastguard Worker
21*f7c14bbaSAndroid Build Coastguard Worker   libbpf_overview
22*f7c14bbaSAndroid Build Coastguard Worker   API Documentation <https://libbpf.readthedocs.io/en/latest/api.html>
23*f7c14bbaSAndroid Build Coastguard Worker   program_types
24*f7c14bbaSAndroid Build Coastguard Worker   libbpf_naming_convention
25*f7c14bbaSAndroid Build Coastguard Worker   libbpf_build
26*f7c14bbaSAndroid Build Coastguard Worker
27*f7c14bbaSAndroid Build Coastguard Worker
28*f7c14bbaSAndroid Build Coastguard WorkerAll general BPF questions, including kernel functionality, libbpf APIs and their
29*f7c14bbaSAndroid Build Coastguard Workerapplication, should be sent to [email protected] mailing list.  You can
30*f7c14bbaSAndroid Build Coastguard Worker`subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the mailing list
31*f7c14bbaSAndroid Build Coastguard Workersearch its `archive <https://lore.kernel.org/bpf/>`_.  Please search the archive
32*f7c14bbaSAndroid Build Coastguard Workerbefore asking new questions. It may be that this was already addressed or
33*f7c14bbaSAndroid Build Coastguard Workeranswered before.
34