linux-kernel - Re: perf tools man pages on the web

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: <CAM9d7cgWXP2s25XUM90=b5Eaojutxi=LobkqrUkRoF5gek4DPQ@mail.gmail.com>
Date:   Mon, 15 Aug 2022 22:07:59 -0700
From:   Namhyung Kim <namhyung@...nel.org>
To:     Ian Rogers <irogers@...gle.com>
Cc:     Adrian Hunter <adrian.hunter@...el.com>,
        Arnaldo Carvalho de Melo <acme@...nel.org>,
        Jiri Olsa <jolsa@...nel.org>, Jonathan Corbet <corbet@....net>,
        Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...hat.com>,
        Mark Rutland <mark.rutland@....com>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        "linux-perf-users@...r.kernel.org" <linux-perf-users@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: perf tools man pages on the web

Hi Ian and Adrian,

On Mon, Aug 15, 2022 at 7:56 AM Ian Rogers <irogers@...gle.com> wrote:
>
> On Mon, Aug 15, 2022 at 5:05 AM Adrian Hunter <adrian.hunter@...el.com> wrote:
> >
> > Hi
> >
> > I notice man pages on man7.org e.g.
> >
> >         https://www.man7.org/linux/man-pages/man1/perf.1.html
> >
> > do not get updated every release, and I wondered if the perf tools
> > man pages should also be under:
> >
> >         https://docs.kernel.org/tools/index.html
> >
> > Thoughts?
>
> Sounds good to me. I'm assuming it would be some kind of build step
> that would take the man pages and add them to what linux-doc needs?

I guess it's the RST format.  I'm not sure if there's a converter
from asciidoc to RST.  Anyway having the perf man pages in the
tools section looks good.

>
> Fwiw, there has been some effort to try to improve the wiki:
> https://perf.wiki.kernel.org/index.php/Main_Page
> For example, the useful links are now broken apart and have more
> links, there is a work-in-progress glossary. Perhaps there can be some
> guidance on what to capture and where.

Thanks for working on this.  I really need to take a look...

Thanks,
Namhyung