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

grantseltzer
2021-05-31T19:56:15Z

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 perhaps large disadvantage of this approach is that libbpf versions
independently from the kernel. If it's possible to version libbpf
separately without having duplicates that would be the ideal scenario.

grantseltzer (2):
Add documentation for libbpf including API autogen
Remove duplicate README doc from libbpf

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

--
2.29.2