linux-perf-users.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Adrian Hunter <adrian.hunter@intel.com>
To: Namhyung Kim <namhyung@kernel.org>, Ian Rogers <irogers@google.com>
Cc: Arnaldo Carvalho de Melo <acme@kernel.org>,
	Jiri Olsa <jolsa@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	"linux-perf-users@vger.kernel.org"
	<linux-perf-users@vger.kernel.org>,
	LKML <linux-kernel@vger.kernel.org>
Subject: Re: perf tools man pages on the web
Date: Tue, 16 Aug 2022 09:04:48 +0300	[thread overview]
Message-ID: <edd637d1-e85c-bc18-a8a2-8aa63d02146f@intel.com> (raw)
In-Reply-To: <CAM9d7cgWXP2s25XUM90=b5Eaojutxi=LobkqrUkRoF5gek4DPQ@mail.gmail.com>

On 16/08/22 08:07, Namhyung Kim wrote:
> Hi Ian and Adrian,
> 
> On Mon, Aug 15, 2022 at 7:56 AM Ian Rogers <irogers@google.com> wrote:
>>
>> On Mon, Aug 15, 2022 at 5:05 AM Adrian Hunter <adrian.hunter@intel.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.

Could use the html files that are already generated by:

	make -C perf/tools html

>                        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


  reply	other threads:[~2022-08-16  8:21 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-15 12:04 perf tools man pages on the web Adrian Hunter
2022-08-15 14:56 ` Ian Rogers
2022-08-16  5:07   ` Namhyung Kim
2022-08-16  6:04     ` Adrian Hunter [this message]
2022-08-16 13:25       ` Ian Rogers
2022-08-17  5:24         ` Adrian Hunter
2022-08-17  6:01           ` Ian Rogers
2022-08-16 20:48   ` Adrian Hunter
2022-08-17 13:02     ` Ian Rogers
2022-08-17 13:21       ` Arnaldo Carvalho de Melo
     [not found]         ` <CA+JHD90RuF+sjO7t40voiQrXbaH172Le=KeKGzTrK_tBquVbAg@mail.gmail.com>
2022-08-18 16:30           ` Ian Rogers
2022-08-25  6:52           ` Adrian Hunter

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=edd637d1-e85c-bc18-a8a2-8aa63d02146f@intel.com \
    --to=adrian.hunter@intel.com \
    --cc=acme@kernel.org \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=irogers@google.com \
    --cc=jolsa@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.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).