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]

Message-ID: <877deaut3b.fsf@meer.lwn.net>
Date:   Mon, 18 Oct 2021 11:43:20 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Daniel Bristot de Oliveira <bristot@...nel.org>,
        Steven Rostedt <rostedt@...dmis.org>
Cc:     Daniel Bristot de Oliveira <bristot@...nel.org>,
        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

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