mirror of
https://github.com/torvalds/linux.git
synced 2024-12-20 10:01:56 +00:00
81de3bf37a
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>
121 lines
3.1 KiB
Plaintext
121 lines
3.1 KiB
Plaintext
## linktep: macro
|
|
#
|
|
# Usage: linktep:command[manpage-section]
|
|
#
|
|
# Note, {0} is the manpage section, while {target} is the command.
|
|
#
|
|
# Show TEP link as: <command>(<section>); if section is defined, else just show
|
|
# the command.
|
|
|
|
[macros]
|
|
(?su)[\\]?(?P<name>linktep):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
|
|
|
|
[attributes]
|
|
asterisk=*
|
|
plus=+
|
|
caret=^
|
|
startsb=[
|
|
endsb=]
|
|
tilde=~
|
|
|
|
ifdef::backend-docbook[]
|
|
[linktep-inlinemacro]
|
|
{0%{target}}
|
|
{0#<citerefentry>}
|
|
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
|
|
{0#</citerefentry>}
|
|
endif::backend-docbook[]
|
|
|
|
ifdef::backend-docbook[]
|
|
ifndef::tep-asciidoc-no-roff[]
|
|
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
|
|
# v1.72 breaks with this because it replaces dots not in roff requests.
|
|
[listingblock]
|
|
<example><title>{title}</title>
|
|
<literallayout>
|
|
ifdef::doctype-manpage[]
|
|
.ft C
|
|
endif::doctype-manpage[]
|
|
|
|
|
ifdef::doctype-manpage[]
|
|
.ft
|
|
endif::doctype-manpage[]
|
|
</literallayout>
|
|
{title#}</example>
|
|
endif::tep-asciidoc-no-roff[]
|
|
|
|
ifdef::tep-asciidoc-no-roff[]
|
|
ifdef::doctype-manpage[]
|
|
# The following two small workarounds insert a simple paragraph after screen
|
|
[listingblock]
|
|
<example><title>{title}</title>
|
|
<literallayout>
|
|
|
|
|
</literallayout><simpara></simpara>
|
|
{title#}</example>
|
|
|
|
[verseblock]
|
|
<formalpara{id? id="{id}"}><title>{title}</title><para>
|
|
{title%}<literallayout{id? id="{id}"}>
|
|
{title#}<literallayout>
|
|
|
|
|
</literallayout>
|
|
{title#}</para></formalpara>
|
|
{title%}<simpara></simpara>
|
|
endif::doctype-manpage[]
|
|
endif::tep-asciidoc-no-roff[]
|
|
endif::backend-docbook[]
|
|
|
|
ifdef::doctype-manpage[]
|
|
ifdef::backend-docbook[]
|
|
[header]
|
|
template::[header-declarations]
|
|
<refentry>
|
|
<refmeta>
|
|
<refentrytitle>{mantitle}</refentrytitle>
|
|
<manvolnum>{manvolnum}</manvolnum>
|
|
<refmiscinfo class="source">libperf</refmiscinfo>
|
|
<refmiscinfo class="version">{libperf_version}</refmiscinfo>
|
|
<refmiscinfo class="manual">libperf Manual</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>{manname1}</refname>
|
|
<refname>{manname2}</refname>
|
|
<refname>{manname3}</refname>
|
|
<refname>{manname4}</refname>
|
|
<refname>{manname5}</refname>
|
|
<refname>{manname6}</refname>
|
|
<refname>{manname7}</refname>
|
|
<refname>{manname8}</refname>
|
|
<refname>{manname9}</refname>
|
|
<refname>{manname10}</refname>
|
|
<refname>{manname11}</refname>
|
|
<refname>{manname12}</refname>
|
|
<refname>{manname13}</refname>
|
|
<refname>{manname14}</refname>
|
|
<refname>{manname15}</refname>
|
|
<refname>{manname16}</refname>
|
|
<refname>{manname17}</refname>
|
|
<refname>{manname18}</refname>
|
|
<refname>{manname19}</refname>
|
|
<refname>{manname20}</refname>
|
|
<refname>{manname21}</refname>
|
|
<refname>{manname22}</refname>
|
|
<refname>{manname23}</refname>
|
|
<refname>{manname24}</refname>
|
|
<refname>{manname25}</refname>
|
|
<refname>{manname26}</refname>
|
|
<refname>{manname27}</refname>
|
|
<refname>{manname28}</refname>
|
|
<refname>{manname29}</refname>
|
|
<refname>{manname30}</refname>
|
|
<refpurpose>{manpurpose}</refpurpose>
|
|
</refnamediv>
|
|
endif::backend-docbook[]
|
|
endif::doctype-manpage[]
|
|
|
|
ifdef::backend-xhtml11[]
|
|
[linktep-inlinemacro]
|
|
<a href="{target}.html">{target}{0?({0})}</a>
|
|
endif::backend-xhtml11[]
|