On Fri, Mar 17, 2023 at 3:53 PM David Vernet <void@xxxxxxxxxxxxx> wrote: > > On Wed, Mar 15, 2023 at 12:54:05PM -0700, Sreevani Sreejith wrote: > > From: Sreevani <ssreevani@xxxxxxxx> > > > > This patch documents overview of libbpf, including its features for > > developing BPF programs. > > > > Signed-off-by: Sreevani <ssreevani@xxxxxxxx> > > Looks great, thanks Sreevani. > > Acked-by: David Vernet <void@xxxxxxxxxxxxx> > Applied suggestions and switched to consistent "=====" over/under top level header in both files. Applied to bpf-next, thanks! > > --- > > Changelog: > > > > v3 = https://lore.kernel.org/all/20230310180928.2462527-1-ssreevani@xxxxxxxx/ > > v3 -> v4: > > * Update BTF types link > > * Update patch summary > > * Indent code options line > > * Update "See also" wording > > > > Documentation/bpf/libbpf/index.rst | 27 ++- > > Documentation/bpf/libbpf/libbpf_overview.rst | 228 +++++++++++++++++++ > > 2 files changed, 246 insertions(+), 9 deletions(-) > > create mode 100644 Documentation/bpf/libbpf/libbpf_overview.rst > > > > diff --git a/Documentation/bpf/libbpf/index.rst b/Documentation/bpf/libbpf/index.rst > > index f9b3b252e28f..3ac8c06fb8f4 100644 > > --- a/Documentation/bpf/libbpf/index.rst > > +++ b/Documentation/bpf/libbpf/index.rst > > @@ -2,23 +2,32 @@ > > > > .. _libbpf: > > > > +###### > > libbpf > > -====== > > +###### > > + > > +If you are looking to develop BPF applications using the libbpf library, this > > +directory contains important documentation that you should read. > > + > > +To get started, it is recommended to begin with the :doc:`libbpf Overview > > +<libbpf_overview>` document, which provides a high-level understanding of the > > +libbpf APIs and their usage. This will give you a solid foundation to start > > +exploring and utilizing the various features of libbpf to develop your BPF > > +applications. > > > > .. toctree:: > > :maxdepth: 1 > > > > + libbpf_overview > > API Documentation <https://libbpf.readthedocs.io/en/latest/api.html> > > program_types > > libbpf_naming_convention > > libbpf_build > > [...]
