Closed rameezrehman408 closed 1 year ago
Any guidance in this matter is very welcome.
make -C docs
(or make -C tools/bpf/bpftool doc
in the kernel repo) will generate the man pages (.8
) from the RST files (.rst
), using rst2man
. Then you can open the page with man
directly.
rst2man
comes with docutils (python3-docutils
on Ubuntu, for example).
One-liner:
$ rst2man docs/bpftool-btf.rst | man -l -
We want the man pages to render the same, ideally we want the code for the man pages (.8
) to remain identical.
Note that the final version of the patches will need to be submitted to the BPF mailing list (I can help).
I believe this is a fix for issue#104.
Only 1 sample file is modified (bpftool-btf.rst), to check if it'll be stable. I am working on setting up the environment to review the docs pages locally. Any guidance in this matter is very welcome.