lkml.org 
[lkml]   [2021]   [Oct]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH V3 13/19] rtla: Add Documentation
On Tue, 19 Oct 2021 14:56:15 +0200
Daniel Bristot de Oliveira <bristot@kernel.org> 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

\
 
 \ /
  Last update: 2021-10-19 15:22    [W:0.082 / U:0.032 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site