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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 19 Oct 2021 16:07:40 +0200
From:   Daniel Bristot de Oliveira <bristot@...nel.org>
To:     Steven Rostedt <rostedt@...dmis.org>
Cc:     Jonathan Corbet <corbet@....net>, Ingo Molnar <mingo@...hat.com>,
        Tom Zanussi <zanussi@...nel.org>,
        Masami Hiramatsu <mhiramat@...nel.org>,
        Juri Lelli <juri.lelli@...hat.com>,
        Clark Williams <williams@...hat.com>,
        John Kacur <jkacur@...hat.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
        linux-rt-users@...r.kernel.org, linux-trace-devel@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH V3 13/19] rtla: Add Documentation

On 10/19/21 15:21, Steven Rostedt wrote:
> On Tue, 19 Oct 2021 14:56:15 +0200
> Daniel Bristot de Oliveira <bristot@...nel.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 ;-)

That is true!

Question, should we mode these files to Documentation/trace/ ?

>>
>> 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.

+1

-- Daniel

> -- Steve
>