Re: [PATCH V3 13/19] rtla: Add Documentation
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
- Subject: Re: [PATCH V3 13/19] rtla: Add Documentation
- From: Steven Rostedt <rostedt@xxxxxxxxxxx>
- Date: Tue, 19 Oct 2021 09:21:24 -0400
- Cc: Jonathan Corbet <corbet@xxxxxxx>, Ingo Molnar <mingo@xxxxxxxxxx>, Tom Zanussi <zanussi@xxxxxxxxxx>, Masami Hiramatsu <mhiramat@xxxxxxxxxx>, Juri Lelli <juri.lelli@xxxxxxxxxx>, Clark Williams <williams@xxxxxxxxxx>, John Kacur <jkacur@xxxxxxxxxx>, Peter Zijlstra <peterz@xxxxxxxxxxxxx>, Thomas Gleixner <tglx@xxxxxxxxxxxxx>, Sebastian Andrzej Siewior <bigeasy@xxxxxxxxxxxxx>, linux-rt-users@xxxxxxxxxxxxxxx, linux-trace-devel@xxxxxxxxxxxxxxx, linux-kernel@xxxxxxxxxxxxxxx
- In-reply-to: <f0c50222-a9a8-d0e5-d705-d9d670467142@kernel.org>
- References: <cover.1634574261.git.bristot@kernel.org> <7e205854656f41afe9a35e6390d3e3cbd724706f.1634574261.git.bristot@kernel.org> <877deaut3b.fsf@meer.lwn.net> <f0c50222-a9a8-d0e5-d705-d9d670467142@kernel.org>
On Tue, 19 Oct 2021 14:56:15 +0200
Daniel Bristot de Oliveira <bristot@xxxxxxxxxx> 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
[Index of Archives]
[Linux USB Development]
[Linux USB Development]
[Linux Audio Users]
[Yosemite Hiking]
[Linux Kernel]
[Linux SCSI]