From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 10DBEC32771 for ; Wed, 17 Aug 2022 05:24:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233297AbiHQFYV (ORCPT ); Wed, 17 Aug 2022 01:24:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46696 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229758AbiHQFYU (ORCPT ); Wed, 17 Aug 2022 01:24:20 -0400 Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C6C3E5FAC; Tue, 16 Aug 2022 22:24:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1660713858; x=1692249858; h=message-id:date:mime-version:subject:to:cc:references: from:in-reply-to:content-transfer-encoding; bh=RuOw0a+zfDrSKH3bQpTCct6nUD3o/er6utR/T/sgNW4=; b=i44bWr4SYMqooJj+0tczklLNYGRvSyLPkORK4eLX6Sxk/1WAw9ykYDAB zZyjeaTgn9kftaDVQSPyba4i8NuSUX7ic+vfoOFdhfdV0d2BtA4l12h1Z CMKj6pG6X9zXhlKo0BIj9y49nzQTbS2YzyMqHFkc2mx6cROdTdqlwUSOV GAE06eN2O9grMke0mjodTqN6SPocxPFogIXKra7QKY8Tha2r0Di37icoy dndiZqN6yHZQpyzLVZtyVL1VkmoNZTDzbHdoNG/unQRLg5Xn9rMGUwMuN GlTjt47ppSmV3UUYVsp4+skqH3Wz+GM5A5yopTmKbq9+ZiY7NmHsSYz79 w==; X-IronPort-AV: E=McAfee;i="6400,9594,10441"; a="318408352" X-IronPort-AV: E=Sophos;i="5.93,242,1654585200"; d="scan'208";a="318408352" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Aug 2022 22:24:18 -0700 X-IronPort-AV: E=Sophos;i="5.93,242,1654585200"; d="scan'208";a="667445041" Received: from ahunter6-mobl1.ger.corp.intel.com (HELO [10.0.2.15]) ([10.252.49.3]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Aug 2022 22:24:14 -0700 Message-ID: <53428314-9dfc-288d-d109-79240fba82ac@intel.com> Date: Wed, 17 Aug 2022 08:24:08 +0300 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Firefox/91.0 Thunderbird/91.11.0 Subject: Re: perf tools man pages on the web Content-Language: en-US To: Ian Rogers , Mauro Carvalho Chehab Cc: Namhyung Kim , Arnaldo Carvalho de Melo , Jiri Olsa , Jonathan Corbet , Peter Zijlstra , Ingo Molnar , Mark Rutland , Alexander Shishkin , "linux-perf-users@vger.kernel.org" , LKML References: From: Adrian Hunter Organization: Intel Finland Oy, Registered Address: PL 281, 00181 Helsinki, Business Identity Code: 0357606 - 4, Domiciled in Helsinki In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 16/08/22 16:25, Ian Rogers wrote: > On Mon, Aug 15, 2022 at 11:05 PM Adrian Hunter wrote: >> >> On 16/08/22 08:07, Namhyung Kim wrote: >>> Hi Ian and Adrian, >>> >>> On Mon, Aug 15, 2022 at 7:56 AM Ian Rogers wrote: >>>> >>>> On Mon, Aug 15, 2022 at 5:05 AM Adrian Hunter 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 > > A lot of the man page makefile code comes from git and wasn't in great > shape the last I looked [1]. I believe that would be true for the HTML > output. As there are existing dependencies on rst2man for BPF [2], I > think it'd be cleaner to migrate all the man pages to rst format with > new man page build rules using rst2man. Wdyt? That seems like a larger job. For now, I am just suggesting copying the html files onto kernel.org. + Mauro Mauro, do you know if that is feasible? > > Thanks, > Ian > > [1] https://lore.kernel.org/all/20210715013343.2286699-1-irogers@google.com/ > [2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/include/uapi/linux/bpf.h#n1538 > >>> 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 >>