mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-02 07:04:24 +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>
35 lines
1.2 KiB
XML
35 lines
1.2 KiB
XML
<!-- manpage-base.xsl:
|
|
special formatting for manpages rendered from asciidoc+docbook -->
|
|
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
|
version="1.0">
|
|
|
|
<!-- these params silence some output from xmlto -->
|
|
<xsl:param name="man.output.quietly" select="1"/>
|
|
<xsl:param name="refentry.meta.get.quietly" select="1"/>
|
|
|
|
<!-- convert asciidoc callouts to man page format;
|
|
git.docbook.backslash and git.docbook.dot params
|
|
must be supplied by another XSL file or other means -->
|
|
<xsl:template match="co">
|
|
<xsl:value-of select="concat(
|
|
$git.docbook.backslash,'fB(',
|
|
substring-after(@id,'-'),')',
|
|
$git.docbook.backslash,'fR')"/>
|
|
</xsl:template>
|
|
<xsl:template match="calloutlist">
|
|
<xsl:value-of select="$git.docbook.dot"/>
|
|
<xsl:text>sp </xsl:text>
|
|
<xsl:apply-templates/>
|
|
<xsl:text> </xsl:text>
|
|
</xsl:template>
|
|
<xsl:template match="callout">
|
|
<xsl:value-of select="concat(
|
|
$git.docbook.backslash,'fB',
|
|
substring-after(@arearefs,'-'),
|
|
'. ',$git.docbook.backslash,'fR')"/>
|
|
<xsl:apply-templates/>
|
|
<xsl:value-of select="$git.docbook.dot"/>
|
|
<xsl:text>br </xsl:text>
|
|
</xsl:template>
|
|
|
|
</xsl:stylesheet>
|