OSDN Git Service

libperf: Add man pages
authorJiri Olsa <jolsa@kernel.org>
Fri, 6 Dec 2019 21:06:12 +0000 (22:06 +0100)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 6 Jan 2020 14:46:09 +0000 (11:46 -0300)
commit81de3bf37a8bf58ecdbef608d16ddb0f4bbb71ca
tree40b3b6a1ad3d3e9c2cb4b24d1fbcc5fb9fb61a04
parent3ce311afb5583cf3d3b7f54ab088949da28aea05
libperf: Add man pages

Change the man page generation to asciidoc, because it's easier to use
and has been more commonly used in related projects. Remove the current
rst pages.

Add 3 man pages to have a base for more additions:

  libperf.3          - overall description
  libperf-counting.7 - counting basics explained on simple example
  libperf-sampling.7 - sampling basics explained on simple example

The plan is to add more man pages to cover the basic API.

The build generates html and man pages:

  $ cd tools/lib/perf/Documentation
  $ make
    ASCIIDOC libperf.xml
    XMLTO    libperf.3
    ASCIIDOC libperf-counting.xml
    XMLTO    libperf-counting.7
    ASCIIDOC libperf-sampling.xml
    XMLTO    libperf-sampling.7
    ASCIIDOC libperf.html
    ASCIIDOC libperf-counting.html
    ASCIIDOC libperf-sampling.html

Add the following install targets:

   install-man      - man pages
   install-html     - html version of man pages
   install-examples - examples mentioned in the man pages

Signed-off-by: Jiri Olsa <jolsa@kernel.org>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Michael Petlan <mpetlan@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: http://lore.kernel.org/lkml/20191206210612.8676-3-jolsa@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
14 files changed:
tools/lib/perf/Documentation/Makefile
tools/lib/perf/Documentation/asciidoc.conf [new file with mode: 0644]
tools/lib/perf/Documentation/examples/sampling.c [new file with mode: 0644]
tools/lib/perf/Documentation/libperf-counting.txt [new file with mode: 0644]
tools/lib/perf/Documentation/libperf-sampling.txt [new file with mode: 0644]
tools/lib/perf/Documentation/libperf.txt [new file with mode: 0644]
tools/lib/perf/Documentation/man/libperf.rst [deleted file]
tools/lib/perf/Documentation/manpage-1.72.xsl [new file with mode: 0644]
tools/lib/perf/Documentation/manpage-base.xsl [new file with mode: 0644]
tools/lib/perf/Documentation/manpage-bold-literal.xsl [new file with mode: 0644]
tools/lib/perf/Documentation/manpage-normal.xsl [new file with mode: 0644]
tools/lib/perf/Documentation/manpage-suppress-sp.xsl [new file with mode: 0644]
tools/lib/perf/Documentation/tutorial/tutorial.rst [deleted file]
tools/lib/perf/Makefile