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 83E0EC25B0E for ; Tue, 16 Aug 2022 13:25:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235795AbiHPNZu (ORCPT ); Tue, 16 Aug 2022 09:25:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37790 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235784AbiHPNZo (ORCPT ); Tue, 16 Aug 2022 09:25:44 -0400 Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3F8D787685 for ; Tue, 16 Aug 2022 06:25:43 -0700 (PDT) Received: by mail-wm1-x32a.google.com with SMTP id c187-20020a1c35c4000000b003a30d88fe8eso9378320wma.2 for ; Tue, 16 Aug 2022 06:25:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc; bh=PblUwHy5mn8FwoYRh4mjjYaylnUC4/ptH+gU2jHD3ZM=; b=l06UJXi0GNQdmRGdCUouJQq/FWDXBbfTCzhaus9QvtDx01UP858Q1+rGbktzjvwXpJ ffQ4cEhYksF3XAnRfqn5txyB0dlnHYRcN1dQM95b4oVfArVtIQceqS1eCxvPWLcpnEKu m5tCP5KDWFQdflTOYL98sUNWU/EwBrstDBNqK0HXsZajGxJ+I+pG+uSvMXpOYRgzSskh 42fD/Uzd9f+UFk4reJA1oE4Jh8EzDuBvlnLtimQ5XxtZIU1wgWnkU79NWRe4wpBoGTie 10NUOTlzc1i4YFHT+1k9SHZeITsWceJR+7ha/oGCmIVurnPinnNfqAAI3j5AYjc3TJb2 TuNg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc; bh=PblUwHy5mn8FwoYRh4mjjYaylnUC4/ptH+gU2jHD3ZM=; b=ImElbmKYkthhzWAW6VLMFE9Vcdw+HygOjYs6h8rmKXRvsEq4S+4sT1gONsMn79XSZ7 PI4Kg7E3OfhlMTDar5u2Lghl8SdXpPK+xutOhu1keZlsF71S4/k+YcDLkBNCFdeakL/l Motl9/Sd9WgKqDx0OPaaFdpjfHixcIz2w/9/ayLxgVog26DahnPtRMPV6ZsLD65yLEl4 PQutgJ6wbcpEXWxzoyfy89MHcLbT931nsT8ghxcL+x276++89lXSynY1OtxxMONQGnBG r0lyDfLZtOBMxYCY9UvjoS8QipKnru8UAn8LHOH0Es3chxLqU0vCUBZOcGLe7kn6S2MQ 4ZBA== X-Gm-Message-State: ACgBeo3cGs4B0p/a25ouZLEbDTeKHJDWLfZmwgj26epTJwmuEhUaApsg fGuLPCwPaH2XWZhIl++lw6dkMHEDf3Ymyk8vdGRpVQ== X-Google-Smtp-Source: AA6agR7gqSpC9S713yep8IGPS4LS21XT520fYnxOl41VWm6yamI7CxxP4jp6z4g8Z7fIRcQZ7kofpdY5mpw+oIazdy8= X-Received: by 2002:a05:600c:25ce:b0:3a5:a3b7:bbfe with SMTP id 14-20020a05600c25ce00b003a5a3b7bbfemr20298781wml.115.1660656341549; Tue, 16 Aug 2022 06:25:41 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Ian Rogers Date: Tue, 16 Aug 2022 06:25:28 -0700 Message-ID: Subject: Re: perf tools man pages on the web To: Adrian Hunter 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 Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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? 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 >