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

[Jonathan Corbet]

Daniel Bristot de Oliveira <bristot@xxxxxxxxxx> 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@xxxxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
> Cc: Tom Zanussi <zanussi@xxxxxxxxxx>
> Cc: Masami Hiramatsu <mhiramat@xxxxxxxxxx>
> Cc: Juri Lelli <juri.lelli@xxxxxxxxxx>
> Cc: Clark Williams <williams@xxxxxxxxxx>
> Cc: John Kacur <jkacur@xxxxxxxxxx>
> Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> Cc: Sebastian Andrzej Siewior <bigeasy@xxxxxxxxxxxxx>
> Cc: Daniel Bristot de Oliveira <bristot@xxxxxxxxxx>
> Cc: linux-rt-users@xxxxxxxxxxxxxxx
> Cc: linux-trace-devel@xxxxxxxxxxxxxxx
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Suggested-by: Steven Rostedt <rostedt@xxxxxxxxxxx>
> Signed-off-by: Daniel Bristot de Oliveira <bristot@xxxxxxxxxx>
> ---
>  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