1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
# SPDX-License-Identifier: LGPL-2.1
#
# Copyright (c) 2023 Daniel Wagner, SUSE LLC
# input text file: man page section
sources = {
'libtracefs-sqlhist.txt.1': '1',
'libtracefs-cpu-buf.txt': '3',
'libtracefs-cpu-map.txt': '3',
'libtracefs-cpu-open.txt': '3',
'libtracefs-cpu.txt': '3',
'libtracefs-dynevents.txt': '3',
'libtracefs-eprobes.txt': '3',
'libtracefs-error.txt': '3',
'libtracefs-events-file.txt': '3',
'libtracefs-events-tep.txt': '3',
'libtracefs-events.txt': '3',
'libtracefs-files.txt': '3',
'libtracefs-filter-pid.txt': '3',
'libtracefs-filter.txt': '3',
'libtracefs-function-filter.txt': '3',
'libtracefs-guest.txt': '3',
'libtracefs-hist-cont.txt': '3',
'libtracefs-hist-mod.txt': '3',
'libtracefs-hist.txt': '3',
'libtracefs-instances-affinity.txt': '3',
'libtracefs-instances-file-manip.txt': '3',
'libtracefs-instances-files.txt': '3',
'libtracefs-instances-manage.txt': '3',
'libtracefs-instances-stat.txt': '3',
'libtracefs-instances-subbuf.txt': '3',
'libtracefs-instances-utils.txt': '3',
'libtracefs-iterator.txt': '3',
'libtracefs-kprobes.txt': '3',
'libtracefs-log.txt': '3',
'libtracefs-marker_raw.txt': '3',
'libtracefs-marker.txt': '3',
'libtracefs-option-get.txt': '3',
'libtracefs-option-misc.txt': '3',
'libtracefs-options.txt': '3',
'libtracefs-snapshot.txt': '3',
'libtracefs-sql.txt': '3',
'libtracefs-stream.txt': '3',
'libtracefs-synth2.txt': '3',
'libtracefs-synth-info.txt': '3',
'libtracefs-synth.txt': '3',
'libtracefs-traceon.txt': '3',
'libtracefs-tracer.txt': '3',
'libtracefs.txt': '3',
'libtracefs-uprobes.txt': '3',
'libtracefs-utils.txt': '3',
}
conf_dir = meson.current_source_dir() + '/'
top_source_dir = meson.current_source_dir() + '/../'
##
# For asciidoc ...
# -7.1.2, no extra settings are needed.
# 8.0-, set ASCIIDOC8.
#
#
# For docbook-xsl ...
# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
# 1.69.0, no extra settings are needed?
# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
# 1.71.1, no extra settings are needed?
# 1.72.0, set DOCBOOK_XSL_172.
# 1.73.0-, set ASCIIDOC_NO_ROFF
#
#
# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
# of 'the ".ft C" problem' in your generated manpages, and you
# instead ended up with weird characters around callouts, try
# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
#
if get_option('asciidoctor')
asciidoc = find_program('asciidoctor')
asciidoc_extra = ['-a', 'compat-mode']
asciidoc_extra += ['-I.']
asciidoc_extra += ['-r', 'asciidoctor-extensions']
asciidoc_extra += ['-a', 'mansource=libtraceevent']
asciidoc_extra += ['-a', 'manmanual="libtraceevent Manual"']
asciidoc_html = 'xhtml5'
else
asciidoc = find_program('asciidoc')
asciidoc_extra = ['--unsafe']
asciidoc_extra += ['-f', conf_dir + 'asciidoc.conf']
asciidoc_html = 'xhtml11'
r = run_command(asciidoc, '--version', check: true)
v = r.stdout().strip()
if v.version_compare('>=8.0')
asciidoc_extra += ['-a', 'asciidoc7compatible']
endif
endif
manpage_xsl = conf_dir + 'manpage-normal.xsl'
if get_option('docbook-xls-172')
asciidoc_extra += ['-a', 'libtraceevent-asciidoc-no-roff']
manpage_xsl = conf_dir + 'manpage-1.72.xsl'
elif get_option('asciidoc-no-roff')
# docbook-xsl after 1.72 needs the regular XSL, but will not
# pass-thru raw roff codes from asciidoc.conf, so turn them off.
asciidoc_extra += ['-a', 'libtraceevent-asciidoc-no-roff']
endif
xmlto = find_program('xmlto')
xmlto_extra = []
if get_option('man-bold-literal')
xmlto_extra += ['-m ', conf_dir + 'manpage-bold-literal.xsl']
endif
if get_option('docbook-suppress-sp')
xmlto_extra += ['-m ', conf_dir + 'manpage-suppress-sp.xsl']
endif
check_doc = custom_target(
'check-doc',
output: 'dummy',
command : [
top_source_dir + 'check-manpages.sh',
meson.current_source_dir()])
gen = generator(
asciidoc,
output: '@BASENAME@.xml',
arguments: [
'-b', 'docbook',
'-d', 'manpage',
'-a', 'libtraceevent_version=' + meson.project_version(),
'-o', '@OUTPUT@']
+ asciidoc_extra
+ ['@INPUT@'])
man = []
html = []
foreach txt, section : sources
# build man page(s)
xml = gen.process(txt)
man += custom_target(
txt.underscorify() + '_man',
input: xml,
output: '@BASENAME@.' + section,
depends: check_doc,
command: [
xmlto,
'-m', manpage_xsl,
'man',
'-o', '@OUTPUT@']
+ xmlto_extra
+ ['@INPUT@'])
# build html pages
html += custom_target(
txt.underscorify() + '_html',
input: txt,
output: '@BASENAME@.html',
depends: check_doc,
command: [
asciidoc,
'-b', asciidoc_html,
'-d', 'manpage',
'-a', 'libtraceevent_version=' + meson.project_version(),
'-o', '@OUTPUT@']
+ asciidoc_extra
+ ['@INPUT@'])
endforeach
# Install path workaround because:
#
# - xmlto might generate more than one file and we would to tell meson
# about those output files. We could figure out which files are generated
# (see sed match in check-manpages.sh).
#
# - The man page generation puts all the generated files under sub dirs
# and it's not obvious how to tell Meson it should not do this without
# causing the install step to fail (confusion where the generated files
# are stored)
#
# - The documentation build is not part of the 'build' target. The user
# has explicitly to trigger the doc build. Hence the documentation is
# not added to the 'install' target.
#
# Thus just use a plain old shell script to move the generated files to the
# right location.
conf = configuration_data()
conf.set('SRCDIR', meson.current_build_dir())
conf.set('MANDIR', mandir)
conf.set('HTMLDIR', htmldir)
configure_file(
input: 'install-docs.sh.in',
output: 'install-docs.sh',
configuration: conf)
meson.add_install_script(
join_paths(meson.current_build_dir(), 'install-docs.sh'))
|
