Re: [PATCH V3 13/19] rtla: Add Documentation
From: Jonathan Corbet <corbet@lwn.net>
Date: 2021-10-18 17:43:25
Also in:
lkml
Daniel Bristot de Oliveira [off-list ref] writes:
Adds the basis for rtla documentation. It is based on libtracefs Documentation as suggested by Steven Rostedt. This patch also includes the rtla(1) man page. Cc: Steven Rostedt <rostedt@goodmis.org> Cc: Ingo Molnar <mingo@redhat.com> Cc: Tom Zanussi <zanussi@kernel.org> Cc: Masami Hiramatsu <mhiramat@kernel.org> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Clark Williams <redacted> Cc: John Kacur <jkacur@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <redacted> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Suggested-by: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org> --- tools/tracing/rtla/Documentation/Makefile | 223 ++++++++++++++++++ .../tracing/rtla/Documentation/asciidoc.conf | 118 +++++++++ .../rtla/Documentation/manpage-base.xsl | 35 +++ .../rtla/Documentation/manpage-normal.xsl | 13 + tools/tracing/rtla/Documentation/rtla.txt | 56 +++++ tools/tracing/rtla/Documentation/utils.mk | 144 +++++++++++ tools/tracing/rtla/Makefile | 20 +- 7 files changed, 604 insertions(+), 5 deletions(-) create mode 100644 tools/tracing/rtla/Documentation/Makefile create mode 100644 tools/tracing/rtla/Documentation/asciidoc.conf create mode 100644 tools/tracing/rtla/Documentation/manpage-base.xsl create mode 100644 tools/tracing/rtla/Documentation/manpage-normal.xsl create mode 100644 tools/tracing/rtla/Documentation/rtla.txt create mode 100644 tools/tracing/rtla/Documentation/utils.mk
So please forgive me for being obnoxious but I have to ask...do we *really* need to add yet another markup language and docs build infrastructure to the kernel? I'm glad to see documentation, of course, but I would be gladder if it weren't a silo completely separate from the rest of the kernel docs. Is there a reason why this couldn't have been done with Sphinx? Thanks, jon