xref: /OK3568_Linux_fs/kernel/tools/perf/Documentation/asciidoc.conf (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun## linkperf: macro
2*4882a593Smuzhiyun#
3*4882a593Smuzhiyun# Usage: linkperf:command[manpage-section]
4*4882a593Smuzhiyun#
5*4882a593Smuzhiyun# Note, {0} is the manpage section, while {target} is the command.
6*4882a593Smuzhiyun#
7*4882a593Smuzhiyun# Show PERF link as: <command>(<section>); if section is defined, else just show
8*4882a593Smuzhiyun# the command.
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun[macros]
11*4882a593Smuzhiyun(?su)[\\]?(?P<name>linkperf):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun[attributes]
14*4882a593Smuzhiyunasterisk=&#42;
15*4882a593Smuzhiyunplus=&#43;
16*4882a593Smuzhiyuncaret=&#94;
17*4882a593Smuzhiyunstartsb=&#91;
18*4882a593Smuzhiyunendsb=&#93;
19*4882a593Smuzhiyuntilde=&#126;
20*4882a593Smuzhiyun
21*4882a593Smuzhiyunifdef::backend-docbook[]
22*4882a593Smuzhiyun[linkperf-inlinemacro]
23*4882a593Smuzhiyun{0%{target}}
24*4882a593Smuzhiyun{0#<citerefentry>}
25*4882a593Smuzhiyun{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
26*4882a593Smuzhiyun{0#</citerefentry>}
27*4882a593Smuzhiyunendif::backend-docbook[]
28*4882a593Smuzhiyun
29*4882a593Smuzhiyunifdef::backend-docbook[]
30*4882a593Smuzhiyunifndef::perf-asciidoc-no-roff[]
31*4882a593Smuzhiyun# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
32*4882a593Smuzhiyun# v1.72 breaks with this because it replaces dots not in roff requests.
33*4882a593Smuzhiyun[listingblock]
34*4882a593Smuzhiyun<example><title>{title}</title>
35*4882a593Smuzhiyun<literallayout>
36*4882a593Smuzhiyunifdef::doctype-manpage[]
37*4882a593Smuzhiyun&#10;.ft C&#10;
38*4882a593Smuzhiyunendif::doctype-manpage[]
39*4882a593Smuzhiyun|
40*4882a593Smuzhiyunifdef::doctype-manpage[]
41*4882a593Smuzhiyun&#10;.ft&#10;
42*4882a593Smuzhiyunendif::doctype-manpage[]
43*4882a593Smuzhiyun</literallayout>
44*4882a593Smuzhiyun{title#}</example>
45*4882a593Smuzhiyunendif::perf-asciidoc-no-roff[]
46*4882a593Smuzhiyun
47*4882a593Smuzhiyunifdef::perf-asciidoc-no-roff[]
48*4882a593Smuzhiyunifdef::doctype-manpage[]
49*4882a593Smuzhiyun# The following two small workarounds insert a simple paragraph after screen
50*4882a593Smuzhiyun[listingblock]
51*4882a593Smuzhiyun<example><title>{title}</title>
52*4882a593Smuzhiyun<literallayout>
53*4882a593Smuzhiyun|
54*4882a593Smuzhiyun</literallayout><simpara></simpara>
55*4882a593Smuzhiyun{title#}</example>
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun[verseblock]
58*4882a593Smuzhiyun<formalpara{id? id="{id}"}><title>{title}</title><para>
59*4882a593Smuzhiyun{title%}<literallayout{id? id="{id}"}>
60*4882a593Smuzhiyun{title#}<literallayout>
61*4882a593Smuzhiyun|
62*4882a593Smuzhiyun</literallayout>
63*4882a593Smuzhiyun{title#}</para></formalpara>
64*4882a593Smuzhiyun{title%}<simpara></simpara>
65*4882a593Smuzhiyunendif::doctype-manpage[]
66*4882a593Smuzhiyunendif::perf-asciidoc-no-roff[]
67*4882a593Smuzhiyunendif::backend-docbook[]
68*4882a593Smuzhiyun
69*4882a593Smuzhiyunifdef::doctype-manpage[]
70*4882a593Smuzhiyunifdef::backend-docbook[]
71*4882a593Smuzhiyun[header]
72*4882a593Smuzhiyuntemplate::[header-declarations]
73*4882a593Smuzhiyun<refentry>
74*4882a593Smuzhiyunifdef::perf_date[]
75*4882a593Smuzhiyun<refentryinfo><date>{perf_date}</date></refentryinfo>
76*4882a593Smuzhiyunendif::perf_date[]
77*4882a593Smuzhiyun<refmeta>
78*4882a593Smuzhiyun<refentrytitle>{mantitle}</refentrytitle>
79*4882a593Smuzhiyun<manvolnum>{manvolnum}</manvolnum>
80*4882a593Smuzhiyun<refmiscinfo class="source">perf</refmiscinfo>
81*4882a593Smuzhiyun<refmiscinfo class="version">{perf_version}</refmiscinfo>
82*4882a593Smuzhiyun<refmiscinfo class="manual">perf Manual</refmiscinfo>
83*4882a593Smuzhiyun</refmeta>
84*4882a593Smuzhiyun<refnamediv>
85*4882a593Smuzhiyun  <refname>{manname}</refname>
86*4882a593Smuzhiyun  <refpurpose>{manpurpose}</refpurpose>
87*4882a593Smuzhiyun</refnamediv>
88*4882a593Smuzhiyunendif::backend-docbook[]
89*4882a593Smuzhiyunendif::doctype-manpage[]
90*4882a593Smuzhiyun
91*4882a593Smuzhiyunifdef::backend-xhtml11[]
92*4882a593Smuzhiyun[linkperf-inlinemacro]
93*4882a593Smuzhiyun<a href="{target}.html">{target}{0?({0})}</a>
94*4882a593Smuzhiyunendif::backend-xhtml11[]
95