Re: [PATCH V3 13/19] rtla: Add Documentation

From
Steven Rostedt <rostedt@goodmis.org>
Date
2021-10-19 13:21:30
Also in
lkml
Reply to
Daniel Bristot de Oliveira, 2021-10-19
On Tue, 19 Oct 2021 14:56:15 +0200
Daniel Bristot de Oliveira [off-list ref] wrote:
I am not a document format specialist, neither have a strong opinion on this, so
suggestions are welcome. I used this format as a suggestion from steven, it is
also similar to what we have on perf...
My suggestion came from not knowing that the man pages were going to live
in the kernel Documentation tree ;-)
The idea here is to create a set of man pages. I saw that it is possible to
create man pages using Sphinx, but there are so many options that it is hard to
get started...

I also noticed that bpftools uses .rst files, but uses rst2man to convert the files.

Converting the current files to .rst is easy.

So, could give me some directions on what you think would be the best way to
create this set of man pages?

A link to a project that creates a set of man pages using Sphinx using a
Makefile would be a plus :-).

If everyone is OK with converting to .rst and using rst2man I'm fine with
that.

-- Steve
Thread (34 messages) 34 messages, 4 authors, last reply 2021-10-19
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help