From: Daniel Bristot de Oliveira <bristot@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: Jonathan Corbet <corbet@lwn.net>, Ingo Molnar <mingo@redhat.com>,
Tom Zanussi <zanussi@kernel.org>,
Masami Hiramatsu <mhiramat@kernel.org>,
Juri Lelli <juri.lelli@redhat.com>,
Clark Williams <williams@redhat.com>,
John Kacur <jkacur@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Thomas Gleixner <tglx@linutronix.de>,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
linux-rt-users@vger.kernel.org,
linux-trace-devel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH V3 13/19] rtla: Add Documentation
Date: Tue, 19 Oct 2021 16:07:40 +0200 [thread overview]
Message-ID: <ecf3bfee-8a7a-e3bf-4fba-af9bc479526e@kernel.org> (raw)
In-Reply-To: <20211019092124.6b403ca4@gandalf.local.home>
On 10/19/21 15:21, Steven Rostedt wrote:
> 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 ;-)
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
>
next prev parent reply other threads:[~2021-10-19 14:33 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-18 16:48 [PATCH V3 00/19] RTLA: An interface for osnoise/timerlat tracers Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 01/19] trace/osnoise: Do not follow tracing_cpumask Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 02/19] trace/osnoise: Split workload start from the tracer start Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 03/19] trace/osnoise: Use start/stop_per_cpu_kthreads() on osnoise_cpus_write() Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 04/19] trace/osnoise: Support a list of trace_array *tr Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 05/19] trace/osnoise: Allow multiple instances of the same tracer Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 06/19] rtla: Real-Time Linux Analysis tool Daniel Bristot de Oliveira
2021-10-18 19:30 ` Ahmed S. Darwish
2021-10-19 8:06 ` Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 07/19] rtla: Helper functions for rtla Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 08/19] rtla: Add osnoise tool Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 09/19] rtla/osnoise: Add osnoise top mode Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 10/19] rtla/osnoise: Add the hist mode Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 11/19] rtla: Add timerlat tool and timelart top mode Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 12/19] rtla/timerlat: Add timerlat hist mode Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 13/19] rtla: Add Documentation Daniel Bristot de Oliveira
2021-10-18 17:43 ` Jonathan Corbet
2021-10-19 12:56 ` Daniel Bristot de Oliveira
2021-10-19 13:21 ` Steven Rostedt
2021-10-19 14:07 ` Daniel Bristot de Oliveira [this message]
2021-10-19 14:45 ` Steven Rostedt
2021-10-19 15:08 ` Daniel Bristot de Oliveira
2021-10-19 15:25 ` Steven Rostedt
2021-10-19 15:43 ` Daniel Bristot de Oliveira
2021-10-19 15:28 ` Jonathan Corbet
2021-10-19 15:36 ` Steven Rostedt
2021-10-19 15:41 ` Daniel Bristot de Oliveira
2021-10-19 19:18 ` Jonathan Corbet
2021-10-18 16:48 ` [PATCH V3 14/19] rtla: Add rtla osnoise man page Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 15/19] rtla: Add rtla osnoise top documentation Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 16/19] rtla: Add rtla osnoise hist documentation Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 17/19] rtla: Add rtla timerlat documentation Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 18/19] rtla: Add rtla timerlat top documentation Daniel Bristot de Oliveira
2021-10-18 16:48 ` [PATCH V3 19/19] rtla: Add rtla timerlat hist documentation Daniel Bristot de Oliveira
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ecf3bfee-8a7a-e3bf-4fba-af9bc479526e@kernel.org \
--to=bristot@kernel.org \
--cc=bigeasy@linutronix.de \
--cc=corbet@lwn.net \
--cc=jkacur@redhat.com \
--cc=juri.lelli@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rt-users@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=mhiramat@kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=tglx@linutronix.de \
--cc=williams@redhat.com \
--cc=zanussi@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).