[PATCH bpf-next v4 0/1] Autogenerating libbpf API documentation

grantseltzer
2021-06-18T14:05:26Z

This patch series is meant to start the initiative to document libbpf.
It includes .rst files which are text documentation describing building,
API naming convention, as well as an index to generated API documentation.

In this approach the generated API documentation is enabled by the kernels
existing kernel documentation system which uses sphinx. The resulting docs
would then be synced to kernel.org/doc

You can test this by running `make htmldocs` and serving the html in
Documentation/output. Since libbpf does not yet have comments in kernel
doc format, see kernel.org/doc/html/latest/doc-guide/kernel-doc.html for
an example so you can test this.

The advantage of this approach is to use the existing sphinx
infrastructure that the kernel has, and have libbpf docs in
the same place as everything else.

The current plan is to have the libbpf mirror sync the generated docs
and version them based on the libbpf releases which are cut on github.

grantseltzer (1):
Add documentation for libbpf including API autogen

Documentation/bpf/index.rst | 13 +++++++
Documentation/bpf/libbpf/libbpf.rst | 14 +++++++
Documentation/bpf/libbpf/libbpf_api.rst | 27 ++++++++++++++
Documentation/bpf/libbpf/libbpf_build.rst | 37 +++++++++++++++++++
.../bpf/libbpf/libbpf_naming_convention.rst | 30 ++++++---------
5 files changed, 103 insertions(+), 18 deletions(-)
create mode 100644 Documentation/bpf/libbpf/libbpf.rst
create mode 100644 Documentation/bpf/libbpf/libbpf_api.rst
create mode 100644 Documentation/bpf/libbpf/libbpf_build.rst
rename tools/lib/bpf/README.rst => Documentation/bpf/libbpf/libbpf_naming_convention.rst (90%)

--
2.31.1