VirtualBox

source: vbox/trunk/doc/manual/Makefile.kmk@ 68316

Last change on this file since 68316 was 68140, checked in by vboxsync, 8 years ago

VBoxManage/unattended: Do the sub-command thing, moving the current operation to 'install' and adding a 'detect' sub-command for probing an ISO. Moved documentation to man_VBoxManage-unattended.xml (lots to do here).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 46.4 KB
Line 
1# $Id: Makefile.kmk 68140 2017-07-27 15:16:23Z vboxsync $
2## @file
3# Sub-Makefile for the VBox User Manual.
4#
5
6#
7# Copyright (C) 2006-2016 Oracle Corporation
8#
9# This file is part of VirtualBox Open Source Edition (OSE), as
10# available from http://www.virtualbox.org. This file is free software;
11# you can redistribute it and/or modify it under the terms of the GNU
12# General Public License (GPL) as published by the Free Software
13# Foundation, in version 2 as it comes in the "COPYING" file of the
14# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16#
17
18#
19# This slightly messy makefile transforms the DocBook XML source for the
20# user manual into presentation output. We support two targets:
21#
22# -- UserManual.pdf, generated by LaTex
23#
24# -- VirtualBox.chm
25#
26# Both files end up in PATH_STAGE_BIN.
27#
28# Both targets indirectly depend on the XML files in this directory;
29# "indirectly" because we first copy them to PATH_TARGET and hack them
30# up a bit for variable substitution and such (see below).
31# The toolchains are roughly like this:
32#
33# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
34# then create a .FO file (another XML format for "formatted objects")
35# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
36#
37# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
38# run our custom "dblatex" perl script on UserManual.xml, which parses
39# the XML (using the Perl SAX parsers) and dumps a matching latex file
40# to UserManual.tex. This is then regularly processed by pdflatex to
41# generate PDF.
42#
43# -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
44# xsltproc to create a .HHP file for the Microsoft Help Compiler, then
45# feed that file to it.
46#
47
48SUB_DEPTH = ../..
49include $(KBUILD_PATH)/subheader.kmk
50
51
52#
53# Globals
54#
55
56# Error out if someone tries to override old globals.
57ifdef HTMLHELPOPTS
58 $(error HTMLHELPOPTS was renamed to VBOX_HTMLHELP_OPTS!)
59endif
60ifdef DOCBOOKPATH
61 $(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
62endif
63ifdef DOCBOOKPATH
64 $(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
65endif
66ifdef XML_CATALOG
67 $(error XML_CATALOG was renamed to VBOX_XML_CATALOG!)
68endif
69ifdef XML_CATALOG_DOCBOOK
70 $(error XML_CATALOG_DOCBOOK was renamed to VBOX_XML_CATALOG_DOCBOOK!)
71endif
72ifdef VBOXMANAGEPATH
73 $(error VBOXMANAGEPATH was renamed to VBOXMANAGEHELP_PATH!)
74endif
75ifdef PDFLATEX_INTERACTION
76 $(error PDFLATEX_INTERACTION was renamed to VBOX_PDFLATEX_INTERACTION!)
77endif
78ifdef PDFLATEX
79 $(error PDFLATEX was renamed to VBOX_PDFLATEX_CMD!)
80endif
81ifdef HHC
82 $(error HHC was renamed to VBOX_HHC!)
83endif
84
85# Source and output locations.
86VBOX_PATH_MANUAL_SRC := $(PATH_SUB_CURRENT)
87VBOX_PATH_MANUAL_OUTBASE := $(PATH_TARGET)/manual
88
89# tool locations
90ifndef VBOX_OSE
91 # use docbook from our tools directory
92 VBOX_PATH_DOCBOOK ?= $(PATH_DEVTOOLS)/common/DocBook/v1.69.1
93 VBOX_PATH_DOCBOOK_DTD ?= $(PATH_DEVTOOLS)/common/docbook-xml/v4.3
94 VBOX_XML_CATALOG ?= $(VBOX_PATH_MANUAL_OUTBASE)/catalog
95 VBOX_XML_CATALOG_DOCBOOK ?= $(VBOX_PATH_MANUAL_OUTBASE)/docbook
96else
97 # use docbook of the build host
98 VBOX_PATH_DOCBOOK ?= http://docbook.sourceforge.net/release/xsl/current/
99endif
100
101# xsltproc with the catalog trick if applicable.
102ifdef VBOX_XML_CATALOG
103 VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" $1 -- \
104 $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS)
105 VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -- \
106 $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS)
107else
108 VBOX_XSLTPROC_WITH_CAT = $(if $(1), $(REDIRECT) $1 --,) $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS)
109 VBOX_XMLLINT_WITH_CAT = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS)
110endif
111
112VBOXMANAGEHELP_PATH ?= $(PATH_STAGE_BIN)/VBoxManageHelp$(SUFF_EXE)
113
114 # VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
115 # without catting the log a million times.
116VBOX_PDFLATEX_INTERACTION ?= batchmode
117ifeq ($(KBUILD_HOST),win)
118 ifndef VBOX_PDFLATEX
119 VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(PATH_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
120 ifneq ($(VBOX_PDFLATEX),)
121 VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
122 endif
123 endif
124 ifndef VBOX_PDFLATEX
125 # Tell MiKTeX to automatically download packages if system wide install.
126 VBOX_PDFLATEX := pdflatex
127 VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
128 endif
129else
130 VBOX_PDFLATEX ?= pdflatex
131 VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version | head -1 | grep 141592 > /dev/null ) && echo -halt-on-error )
132 VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
133endif
134
135# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
136VBOX_HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
137
138
139# Additional xsltproc options when generating
140VBOX_HTMLHELP_OPTS ?=
141
142# SDK related globals.
143VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
144VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
145VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
146
147##
148# Non-pattern-rule approach to editing XSLT files.
149# $(evalcall2 def_vbox_replace_paths_in_xslt)
150# @param 1 The XSLT source file (relative to Makefile dir).
151# @param 2 Optional output subdirectory (leading slash).
152define def_vbox_replace_paths_in_xslt
153OTHER_CLEAN += $$(VBOX_PATH_MANUAL_OUTBASE)$2/$(notdir $1)
154$$(VBOX_PATH_MANUAL_OUTBASE)$2/$(notdir $1): $$(VBOX_PATH_MANUAL_SRC)/$1 | $$$$(dir $$$$@)
155 $$(call MSG_L1,Pre-processing $$(<) to $$(@))
156 $$(QUIET)$$(SED) \
157 -e 's|@VBOX_PATH_DOCBOOK@|$$(VBOX_PATH_DOCBOOK)|g' \
158 -e 's|@VBOX_PATH_MANUAL_SRC@|$$(VBOX_PATH_MANUAL_SRC)|g' \
159 -e 's|@VBOX_PATH_MANUAL_OUTBASE@|$$(VBOX_PATH_MANUAL_OUTBASE)|g' \
160 -e 's|@VBOX_PATH_MANUAL_OUT_LANG@|$$(VBOX_PATH_MANUAL_OUTBASE)$2|g' \
161 --output "$$(@)" $$<
162endef
163
164##
165# Non-pattern-rule approach to editing XML files.
166# $(evalcall2 def_vbox_replace_stuff_in_xml)
167# @param 1 The XSLT source file (relative to Makefile dir).
168# @param 2 Optional output subdirectory (leading slash).
169#
170define def_vbox_replace_stuff_in_xml
171OTHER_CLEAN += $$(VBOX_PATH_MANUAL_OUTBASE)$2/$(notdir $1)
172$$(VBOX_PATH_MANUAL_OUTBASE)$2/$(notdir $1): $$(VBOX_PATH_MANUAL_SRC)/$1 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
173 $$(call MSG_L1,Pre-processing $$(<) to $$(@))
174 $$(QUIET)$$(SED) \
175 -e 's|@VBOX_PATH_DOCBOOK@|$$(VBOX_PATH_DOCBOOK)|g' \
176 -e 's|@VBOX_PATH_MANUAL_SRC@|$$(VBOX_PATH_MANUAL_SRC)|g' \
177 -e 's|@VBOX_PATH_MANUAL_OUTBASE@|$$(VBOX_PATH_MANUAL_OUTBASE)|g' \
178 -e 's|@VBOX_PATH_MANUAL_OUT_LANG@|$$(VBOX_PATH_MANUAL_OUTBASE)$2|g' \
179 \
180 -e 's/@VBOX_VERSION_MAJOR@/$$(VBOX_VERSION_MAJOR)/g' \
181 -e 's/@VBOX_VERSION_MINOR@/$$(VBOX_VERSION_MINOR)/g' \
182 -e 's/@VBOX_VERSION_BUILD@/$$(VBOX_VERSION_BUILD)/g' \
183 -e 's/@VBOX_VERSION_STRING@/$$(VBOX_VERSION_STRING)/g' \
184 -e 's/@VBOX_VENDOR@/$$(VBOX_VENDOR)/g' \
185 -e 's/@VBOX_PRODUCT@/$$(VBOX_PRODUCT)/g' \
186 -e 's/@VBOX_C_YEAR@/$$(VBOX_C_YEAR)/g' \
187 \
188 --output "$$(@)" $$<
189endef
190
191## List of refentry files (manpages).
192VBOX_MANUAL_XML_REFENTRY_FILES = \
193 man_VBoxManage-debugvm.xml \
194 man_VBoxManage-extpack.xml \
195 man_VBoxManage-unattended.xml
196
197
198#
199# Targets
200#
201
202BLDDIRS += $(VBOX_PATH_MANUAL_OUTBASE) $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
203
204
205if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
206 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF)
207 ## @todo make this an install target, drop the BLDDIRS.
208 OTHERS += \
209 $(VBOX_PATH_SDK)/docs/SDKRef.pdf
210 BLDDIRS += \
211 $(VBOX_PATH_SDK)/docs
212 endif
213
214 ifdef VBOX_WITH_DOCS_CHM
215 VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
216 else # Do not build chm.
217 VBOX_PATH_BIN_CHM =
218 endif
219
220 ifndef VBOX_ONLY_SDK
221 VBOX_MANUAL_PACK += \
222 $(PATH_STAGE_BIN)/UserManual.pdf \
223 $(VBOX_PATH_BIN_CHM)
224 OTHERS += \
225 $(PATH_STAGE_BIN)/UserManual.pdf
226 OTHERS.win += \
227 $(VBOX_PATH_BIN_CHM)
228 OTHERS.linux += \
229 $(VBOX_PATH_BIN_CHM)
230
231 ifdef VBOX_WITH_DOCS_TRANSLATIONS
232 OTHERS += \
233 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
234 ifdef VBOX_WITH_DOCS_CHM
235 OTHERS.win += \
236 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
237 OTHERS.linux += \
238 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
239 endif
240 endif
241 endif # !VBOX_ONLY_SDK
242 ifdef VBOX_ONLY_DOCS
243 PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
244 endif
245
246 ifdef VBOX_WITH_DOCS_TRANSLATIONS
247 VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
248 endif
249
250 VBOX_MANUAL_XML_CHANGELOG = \
251 user_ChangeLogImpl.xml
252
253 VBOX_MANUAL_XML_FILES = \
254 UserManual.xml \
255 user_AdvancedTopics.xml \
256 user_BasicConcepts.xml \
257 user_Glossary.xml \
258 user_Frontends.xml \
259 user_Installation.xml \
260 user_GuestAdditions.xml \
261 user_Introduction.xml \
262 user_KnownIssues.xml \
263 user_PrivacyPolicy.xml \
264 user_Security.xml \
265 user_Technical.xml \
266 user_ThirdParty.xml \
267 user_Troubleshooting.xml \
268 user_VBoxManage.xml \
269 user_VirtualBoxAPI.xml \
270 user_Storage.xml \
271 user_Networking.xml
272
273 VBOX_MANUAL_XML_FILES_INCL_CHANGELOG = $(VBOX_MANUAL_XML_FILES) \
274 user_ChangeLog.xml
275
276 VBOX_SDKREF_XML_FILES = \
277 SDKRef.xml
278
279 # Wildcard the images path for every supported language
280 $(foreach f,$(VBOX_MANUAL_LANGUAGES), \
281 $(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
282
283 VBOX_MANUAL_TEX_UNICODE_FILES = \
284 $(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
285
286 VBOX_MANUAL_LATEX_FILES_TARGET = \
287 $(addprefix UserManual.,aux log out toc tex)
288
289 VBOX_SDKREF_LATEX_FILES_TARGET = \
290 $(addprefix SDKRef.,aux log out toc tex)
291
292 BLDDIRS += \
293 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/,\
294 $(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
295 $(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
296 $(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
297 $(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
298 $(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
299 )
300
301 ifdef VBOX_WITH_DOCS_CHM
302 VBOX_MANUAL_PACK += \
303 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf $(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
304 endif
305
306 OTHER_CLEAN += \
307 $(VBOX_XML_CATALOG) \
308 $(VBOX_XML_CATALOG_DOCBOOK) \
309 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
310 $(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG) \
311 $(VBOX_MANUAL_XML_REFENTRY_FILES) \
312 $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
313 $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
314 $(VBOX_MANUAL_LATEX_FILES_TARGET) \
315 $(VBOX_MANUAL_PNG_FILES_$(lang)) \
316 $(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
317 $(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
318 html-single/UserManual.html \
319 $(addprefix HTMLHelp/, index.html go01.html) \
320 $(addprefix html-chunks/, index.html go01.html) \
321 $(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
322 ,html-chunks/ch$(n).html \
323 html-chunks/re$(n).html \
324 HTMLHelp/ch$(n).html \
325 HTMLHelp/re$(n).html \
326 $(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,HTMLHelp/ch$(n)s$(d2)$(d1).html)) ) \
327 $(foreach n,a b c \
328 ,html-chunks/ap$(n).html \
329 HTMLHelp/ap$(n).html \
330 $(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,HTMLHelp/ap$(n)s$(s).html) ) \
331 HTMLHelp/toc.hhc \
332 HTMLHelp/htmlhelp.hhp \
333 titlepage-htmlhelp.xsl \
334 UserManual.pdf \
335 VirtualBox.chm \
336 ChangeLog.html \
337 validatemanual.run \
338 )) \
339 $(VBOX_PATH_MANUAL_OUTBASE)/$(VBOX_MANUAL_XML_CHANGELOG) \
340 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
341 $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
342 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
343 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
344 $(PATH_STAGE_BIN)/UserManual.pdf \
345 $(PATH_STAGE_BIN)/VirtualBox.chm \
346 \
347 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
348 $(VBOX_SDKREF_XML_FILES) \
349 $(VBOX_SDKREF_LATEX_FILES_TARGET) \
350 SDKRef.pdf \
351 ) \
352 $(VBOX_DOC_XIDL_SRC_TMP) \
353 $(VBOX_MANUAL_APIREF_TMP) \
354 $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
355
356endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
357
358
359
360#
361# To avoid network I/O for fetching DTDs, we generate catalogs mapping the public
362# entity IDs to local files. (Obviously, only done when we have local files.)
363#
364ifdef VBOX_XML_CATALOG
365# Create a catalog file for xsltproc that points to docbook catalog.
366$(VBOX_XML_CATALOG): $(MAKEFILE_CURRENT) | $$(dir $$@)
367 $(call MSG_L1,Creating catalog $@)
368 $(QUIET)$(RM) -f [email protected] $@
369 $(QUIET)$(APPEND) [email protected] '<?xml version="1.0"?>'
370 $(QUIET)$(APPEND) [email protected] '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">'
371 $(QUIET)$(APPEND) [email protected] '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">'
372 $(QUIET)$(APPEND) [email protected] ' <delegatePublic publicIdStartString="-//OASIS/ENTITIES DocBook XML" catalog="file:///$(VBOX_XML_CATALOG_DOCBOOK)"/>'
373 $(QUIET)$(APPEND) [email protected] ' <delegatePublic publicIdStartString="-//OASIS/DTD DocBook XML" catalog="file:///$(VBOX_XML_CATALOG_DOCBOOK)"/>'
374 $(QUIET)$(APPEND) [email protected] ' <delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/" catalog="file:///$(VBOX_XML_CATALOG_DOCBOOK)"/>'
375 $(QUIET)$(APPEND) [email protected] ' <delegateURI uriStartString="http://www.oasis-open.org/docbook/" catalog="file:///$(VBOX_XML_CATALOG_DOCBOOK)"/>'
376 $(QUIET)$(APPEND) [email protected] '</catalog>'
377 $(QUIET)$(MV) -f [email protected] $@
378
379# Create a docbook catalog file for xsltproc that points to the local docbook files.
380$(VBOX_XML_CATALOG_DOCBOOK): $(MAKEFILE_CURRENT) | $$(dir $$@)
381 $(call MSG_L1,Creating catalog $@)
382 $(QUIET)$(RM) -f [email protected] $@
383 $(QUIET)$(APPEND) [email protected] '<?xml version="1.0"?>'
384 $(QUIET)$(APPEND) [email protected] '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">'
385 $(QUIET)$(APPEND) [email protected] '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">'
386 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//ELEMENTS DocBook XML Information Pool V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/dbpoolx.mod"/>'
387 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//DTD DocBook XML V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd"/>'
388 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//DTD DocBook XML V4.4//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd"/>'
389 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//ENTITIES DocBook XML Character Entities V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/dbcentx.mod"/>'
390 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//ENTITIES DocBook XML Notations V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/dbnotnx.mod"/>'
391 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//ENTITIES DocBook XML Additional General Entities V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/dbgenent.mod"/>'
392 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//ELEMENTS DocBook XML Document Hierarchy V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/dbhierx.mod"/>'
393 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/soextblx.dtd"/>'
394 $(QUIET)$(APPEND) [email protected] ' <public publicId="-//OASIS//DTD DocBook XML CALS Table Model V4.3//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/calstblx.dtd"/>'
395 $(QUIET)$(APPEND) [email protected] ' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///$(VBOX_PATH_DOCBOOK_DTD)"/>'
396 $(QUIET)$(APPEND) [email protected] ' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///$(VBOX_PATH_DOCBOOK_DTD)"/>'
397 $(QUIET)$(APPEND) [email protected] ' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///$(VBOX_PATH_DOCBOOK_DTD)"/>'
398 $(QUIET)$(APPEND) [email protected] ' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///$(VBOX_PATH_DOCBOOK_DTD)"/>'
399 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsa.ent"/>'
400 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsb.ent"/>'
401 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsc.ent"/>'
402 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsn.ent"/>'
403 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amso.ent"/>'
404 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsr.ent"/>'
405 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Box and Line Drawing//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-box.ent"/>'
406 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Russian Cyrillic//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr1.ent"/>'
407 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr2.ent"/>'
408 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Diacritical Marks//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-dia.ent"/>'
409 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Greek Letters//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk1.ent"/>'
410 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Monotoniko Greek//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk2.ent"/>'
411 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Greek Symbols//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk3.ent"/>'
412 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk4.ent"/>'
413 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 1//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat1.ent"/>'
414 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 2//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat2.ent"/>'
415 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-num.ent"/>'
416 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES Publishing//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-pub.ent"/>'
417 $(QUIET)$(APPEND) [email protected] ' <public publicId="ISO 8879:1986//ENTITIES General Technical//EN" uri="file:///$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-tech.ent"/>'
418 $(QUIET)$(APPEND) [email protected] '</catalog>'
419 $(QUIET)$(MV) -f [email protected] $@
420endif
421
422
423if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
424
425
426##########################################################################################
427#
428# Rules: Preprocess DocBook XML files
429# (preliminary step for both CHM and PDF generation)
430#
431##########################################################################################
432
433#
434# The following rules for $(VBOX_PATH_MANUAL_OUTBASE)/*.xml process the XML files
435# in doc/manual to allow for some magic variable replacements. The PDF and CHM
436# targets do not depend on the XML files in doc/manual, but those in
437# $(VBOX_PATH_MANUAL_OUTBASE) instead, which we copy there from here, after that magic
438# processing.
439#
440# So, before copying, the following steps are performed:
441#
442# -- $VBOX_VERSION_* strings are replaced with the actual current VBox version.
443# -- $VBOX_MANAGE_OUTPUT (in VBoxManage.xml) is replaced with the current
444# output of the actual VBoxManage program, to save us from having to
445# update the manual all the time.
446#
447
448# Only one changelog for all languages
449# $(VBOX_PATH_MANUAL_OUTBASE)/$(VBOX_MANUAL_XML_CHANGELOG): $(VBOX_PATH_MANUAL_SRC)/$(VBOX_MANUAL_XML_CHANGELOG) | $$(dir $$@)
450# $(QUIET)$(INSTALL) -m 0644 $< $@
451
452# Manual dependency on user_ChangeLogImpl.xml
453$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
454,$(eval $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_ChangeLog.xml: $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml))
455
456# Manual dependency for user_VBoxManage.xml.
457$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
458$(eval $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_VBoxManage.xml: $(VBOX_PATH_MANUAL_SRC)/$(lang)/user_VBoxManage.xml \
459 $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
460 $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
461 $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml ))
462
463# Intermediate step to do some variable replacement in the document.
464$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG) \
465,$(evalcall2 def_vbox_replace_stuff_in_xml,/$(lang)/$(file),/$(lang))))
466
467##
468# Morph man pages into manual sections.
469# $(evalcall2 def_vbox_refentry_to_user_sect1)
470# @param 1 The XSLT source file (relative to Makefile dir).
471# @param 2 Optional output subdirectory.
472define def_vbox_refentry_to_user_sect1
473$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): \
474 $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
475 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
476 $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
477 $$(VBOX_VERSION_STAMP) | $$(dir $$@)
478 $$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
479 $$(QUIET)$$(RM) -f "$$@"
480 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
481endef
482$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
483, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file))))
484
485
486# Generates the VBoxManage command overview include file (shared between
487# languages) from the refsynopsisdiv section of the man pages.
488$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
489 $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
490 $$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
491 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
492 | $$(dir $$@)
493 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
494 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
495
496$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml: $(VBOXMANAGEHELP_PATH) $(MAKEFILE_CURRENT) | $$(dir $$@)
497 $(call MSG_GENERATE,,$@,)
498 $(QUIET)$(RM) -f $@ [email protected]
499 $(QUIET)$(APPEND) -tn "$@" \
500 '<?xml version="1.0" encoding="UTF-8"?>' \
501 '<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">' \
502 '<sect1> <!-- this will be skipped via xpointer in the include. --> '
503 $(QUIET)$(REDIRECT) -wo [email protected] -E 'VBOX_LOG_FLAGS=disabled' -E 'VBOX_LOG_DEST=nofile' \
504 $(if $(eq $(KBUILD_TARGET),darwin), -E 'DYLD_FALLBACK_LIBRARY_PATH=$(dir $(LIB_RUNTIME))') \
505 -- \
506 $(VBOXMANAGEHELP_PATH) --dumpopts
507 $(QUIET)$(SED) \
508 -e ':a' \
509 -e 'N' \
510 -e '$(DOLLAR)!ba' \
511 -e 's/</\&lt\;/g' \
512 -e 's/>/\&gt\;/g' \
513 -e 's/\n*$(DOLLAR)/<\/screen>/' \
514 -e 's/^/<screen>/' \
515 --append $@ [email protected]
516 $(QUIET)$(RM) -f [email protected]
517 $(QUIET)$(APPEND) -n "$@" \
518 ' <remark role="VBoxManage-overview">' \
519 $(foreach refentry, $(filter man_VBoxManage%,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
520 , ' <xi:include href="overview_$(refentry)" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />') \
521 ' </remark>' \
522 '</sect1>'
523
524
525
526
527##########################################################################################
528#
529# Shared rules for PDF generation
530#
531##########################################################################################
532
533ifndef VBOX_OSE
534# copy ucs.sty and related files
535$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
536 $(call MSG_L1,Copying unicode support for LaTeX)
537 $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
538endif
539
540# copy the PNG files.
541# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
542define def_vbox_cp_images_pdf
543local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
544$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
545 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
546 $$(call MSG_L1,Copying temporary $$< => $$@)
547 $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
548endef
549
550$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
551
552
553##########################################################################################
554#
555# UserManual.pdf
556#
557##########################################################################################
558
559## @todo INSTALLS target for this!
560$(PATH_STAGE_BIN)/UserManual.pdf: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf | $$(dir $$@)
561 $(QUIET)$(CP) $< $@
562 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
563
564$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf): \
565 $(PATH_STAGE_BIN)/UserManual_%.pdf : $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf
566 $(QUIET)$(CP) $< $@
567 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
568
569$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.pdf): \
570 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf : \
571 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.tex \
572 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/%/ucs.sty) \
573 $(foreach f,$(VBOX_MANUAL_LANGUAGES),\
574 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_PNG_FILES_$(f)))) | $$(dir $$@)
575# PDF generation via Latex: generate the .tex file
576 $(call MSG_L1,pdflatex $< (four passes) -> $@)
577 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(VBOX_PDFLATEX_CMD) UserManual.tex
578 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(VBOX_PDFLATEX_CMD) UserManual.tex
579 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(VBOX_PDFLATEX_CMD) UserManual.tex
580 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(VBOX_PDFLATEX_CMD) UserManual.tex
581 $(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
582 $(QUIET)$(SED) -n \
583 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
584 $(basename $@).log
585
586##@todo restore this when above has been converted to INSTALLS target. $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
587
588# generate temporary LaTeX source from processed XML
589$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.tex): \
590 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.tex : \
591 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.xml \
592 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
593 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/%/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
594 $(if $(and $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_DOCBOOK_DTD)),$(VBOX_PATH_MANUAL_OUTBASE)/%/validatemanual.run,) \
595 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT)
596 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
597 $(QUIET)$(RM) -f $(addprefix $(@D)/,$(VBOX_MANUAL_LATEX_FILES_TARGET))
598# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
599# pass current language to xsltproc in TARGETLANG variable (extract it from the
600# current directory, should become "de_DE" or the like)
601 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(notdir $(@D)) \
602 -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
603# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
604# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
605 $(QUIET)$(SED) \
606 -e 's|^\\QUOTE{}|\\OQ{}|g' \
607 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
608 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
609 --output $@ [email protected]
610 $(QUIET)$(RM) -f [email protected]
611
612# Useful aliases
613usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
614
615debug-usermanual:
616 $(MAKE) --pretty-command-printing -j1 VBOX_PDFLATEX_INTERACTION=errorstopmode $(PATH_STAGE_BIN)/UserManual.pdf
617
618#
619# Generate rules for validating the UserManual.xml. These are invoked
620# automatically at build time, but can also be manually invoked via the
621# 'validatemanual' and 'validatemanual_<lang>' aliases.
622#
623define def_vbox_validate_xml
624validatemanual_$(lang):: $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run
625$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run: \
626 $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/UserManual.xml \
627 $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
628 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(MAKEFILE_CURRENT) | $$$$(dir $$$$@)
629 $$(call MSG_L1,Validating $$<)
630 $$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
631 $$(QUIET)$$(APPEND) -t "$$@" "done"
632endef
633$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_validate_xml))
634validatemanual:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),validatemanual_$(lang))
635
636
637
638#
639# SDKRef.pdf
640#
641
642# Replace <tt> tags in VirtualBox.xidl.
643$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) | $$(dir $$@)
644 $(call MSG_L1,Generating $@)
645 $(QUIET)$(SED) -e 's|@a \+\(\w\+\)|<tt>\1</tt>|g' \
646 -e 's|@c \+\(\w\+\)|<tt>\1</tt>|g' \
647 --output $@ $<
648
649# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
650$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
651 $(call MSG_L1,Generating $@)
652 $(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
653
654$(evalcall2 def_vbox_replace_stuff_in_xml,/en_US/SDKRef.xml,/en_US)
655$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.xml: $(VBOX_MANUAL_APIREF_TMP)
656
657# Turn SDKRef.xml into latex.
658$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
659 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
660 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
661 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT) | $$(dir $$@)
662 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
663 $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
664## check it for validity first.
665#ifdef VBOX_HAVE_XMLLINT
666# $(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
667#endif
668# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
669 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
670 -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
671# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
672# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
673 $(QUIET)$(SED) \
674 -e 's|^\\QUOTE{}|\\OQ{}|g' \
675 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
676 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
677 --output $@ [email protected]
678 $(QUIET)$(RM) -f [email protected]
679
680# Turn SDKRef.tex into a PDF.
681$(VBOX_PATH_SDK)/docs/SDKRef.pdf: \
682 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
683 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
684 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
685 $(QUIET)$(MKDIR) -p $(VBOX_PATH_SDK)/docs
686 $(call MSG_L1,pdflatex $< (three passes))
687 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
688 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
689 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
690 $(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
691 $(QUIET)$(SED) -n \
692 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
693 $(basename $<).log
694 $(QUIET)$(CP) $(<D)/SDKRef.pdf $@
695 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
696
697
698# Handy aliases.
699validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.xml
700sdkref:: $(VBOX_PATH_SDK)/docs/SDKRef.pdf
701
702
703ifdef VBOX_WITH_DOCS_CHM
704 #
705 # VirtualBox.chm
706 #
707 # We first generate a .hhp help source file from the preprocessed
708 # DocBook XML files, as defined above, then feed that into the
709 # Microsoft Help Compiler.
710 #
711 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-htmlhelp-formatcfg.xsl,/$(lang)))
712
713 # Manual formatcfg dependencies for the above.
714 $(foreach lang,$(VBOX_MANUAL_LANGUAGES), $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/docbook-htmlhelp-formatcfg.xsl): \
715 $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
716 $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
717
718 $(PATH_STAGE_BIN)/VirtualBox.chm: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
719 $(QUIET)$(CP) $< $@
720 $(call MSG_L1,Fresh CHM is now at $@)
721
722 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm): \
723 $(PATH_STAGE_BIN)/VirtualBox_%.chm : $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm
724 $(QUIET)$(CP) $< $@
725 $(call MSG_L1,Fresh CHM is now at $@)
726
727 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/VirtualBox.chm): \
728 $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm: \
729 $(VBOX_PATH_MANUAL_OUTBASE)/%/HTMLHelp/htmlhelp.hhp \
730 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(f))))
731 $(call MSG_L1,hhc $<,=> $@)
732 $(QUIET)$(RM) -f $@
733 $(QUIET)$(VBOX_HHC) $(subst /,\\,$<)
734
735 # Prepare the XSL file for our title page, htmlhelp variant.
736 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/titlepage-htmlhelp.xsl): \
737 $(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) | $$(dir $$@)
738 $(call MSG_L1,xsltproc $<)
739 $(QUIET)$(RM) -f [email protected] $@
740 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
741 $(QUIET)$(MV) -f [email protected] $@
742
743 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/htmlhelp.hhp): \
744 $(VBOX_PATH_MANUAL_OUTBASE)/%/HTMLHelp/htmlhelp.hhp: \
745 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.xml \
746 $(VBOX_PATH_MANUAL_OUTBASE)/%/docbook-htmlhelp-formatcfg.xsl \
747 $(VBOX_PATH_MANUAL_OUTBASE)/%/titlepage-htmlhelp.xsl \
748 $(VBOX_PATH_MANUAL_OUTBASE)/%/validatemanual.run \
749 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/%/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
750 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK)
751 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
752 $(QUIET)$(RM) -f $@
753 $(QUIET)$(MKDIR) -p $(@D)
754 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output $(@D)/ \
755 --stringparam htmlhelp.chm \
756 $(subst /,\\,$(@D)/../VirtualBox.chm) \
757 $(HTMLHELPOPTS) $(@D)/../docbook-htmlhelp-formatcfg.xsl \
758 $<
759
760 # copy the PNG files.
761 # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
762 define def_vbox_cp_images_html
763 local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
764 $$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
765 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
766 $$(call MSG_L1,Copying temporary $$< => $$@)
767 $$(QUIET)$$(CP) -f $$< $$@
768 endef
769
770 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_html)))
771
772 # Packing the docs into a zip file
773 $(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
774 $(call MSG_L1,Packing documentation $@)
775 $(QUIET)$(RM) -f $@
776 $(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
777
778endif # VBOX_WITH_DOCS_CHM
779
780
781##########################################################################################
782#
783# UserManual.html
784#
785##########################################################################################
786$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-html-one-page-formatcfg.xsl,/en_US)
787$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-html-chunks-formatcfg.xsl,/en_US)
788
789# Manual formatcfg dependencies.
790$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
791$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl: \
792 $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
793 $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
794
795$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
796 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
797 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
798 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
799 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
800 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
801 | $$(dir $$@)
802 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
803 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
804 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
805 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
806 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml
807
808$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
809 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl \
810 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
811 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
812 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
813 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
814 | $$(dir $$@)
815 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
816 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
817 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
818 --stringparam chunk.section.depth 0 \
819 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl \
820 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml
821
822$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
823 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
824 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
825 $(call MSG_L1,Packing documentation $@)
826 $(QUIET)$(RM) -f $@
827 $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
828 -9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
829
830html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
831html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
832html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
833
834
835#
836# ChangeLog.html
837#
838# This XSLT rule depends on $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml, which is build by the complex rule
839# $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_ChangeLog.xml): ...
840# much further above. That rule takes en_US/user_ChangeLog.xml and replaces $VIRTUALBOX_CHANGELOG_IMPL
841# with the actual change log contained in user_ChangeLogImpl.xml
842#
843$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-changelog-formatcfg.xsl,/en_US)
844$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
845 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-changelog-formatcfg.xsl \
846 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
847 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) | $$(dir $$@)
848 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
849 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
850 $(call MSG_L1,Fresh ChangeLog.html is now at $@)
851
852cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
853
854
855
856endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
857
858
859#
860# VBoxManage man pages (parts also required by VBoxManage build-in help).
861#
862$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-manpage.xsl,)
863
864##
865# Emits rules for preprocessing refentry sources (applying remarks element),
866# and for producing the actual man pages.
867# $(evalcall2 def_vbox_refentry_to_manpage)
868# @param 1 The language
869# @param 2 The file name (no path).
870define def_vbox_refentry_to_manpage
871$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
872 $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
873 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
874 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) \
875 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
876 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
877 $$(QUIET)$$(RM) -f "$$@"
878 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
879 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
880if defined(VBOX_HAVE_XMLLINT) && "$(USER)" == "bird" # Effing stuff happends on build servers, probably kmk related...
881 $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
882endif
883
884$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
885 $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
886 $$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-manpage.xsl \
887 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) \
888 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
889 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
890 $$(QUIET)$$(RM) -f "$$@"
891 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-manpage.xsl $$<
892endef
893$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
894, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
895
896
897# Handy aliases.
898validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
899man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
900 ,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
901
902
903#
904# VBoxManage built-in help.
905#
906# Note! Generating the stuff here is a bit annoying, but currently the most
907# practical way I can come up with.
908#
909OTHERS += \
910 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp \
911 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h
912OTHER_CLEAN += \
913 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp \
914 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp.ts \
915 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h \
916 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h.ts
917help-experiment:: \
918 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp \
919 $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h
920
921$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-C-help.xsl,)
922$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-H-help.xsl,)
923
924$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-C-help.xsl: $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl # manual dependency.
925
926$(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp.ts \
927+| $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp: \
928 $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-C-help.xsl \
929 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
930 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
931 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(filter %.xml,$^),$(patsubst %.ts,%,$@))
932 $(QUIET)$(APPEND) -tn "$@" \
933 '/* Autogenerated by $<, do not edit! */' \
934 '' \
935 '#include <iprt/types.h>' \
936 '#include "VBoxManageBuiltInHelp.h"' \
937 ''
938 $(foreach refentry,$(filter %.xml,$^) \
939 ,$(NLTAB)$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$@") $< $(refentry))
940 $(QUIET)$(APPEND) -n "$@" \
941 '' \
942 'PCREFENTRY g_apHelpEntries[] = ' \
943 '{'
944 $(foreach refentry,$(filter %.xml,$^) \
945 ,$(NLTAB)$(QUIET)$(APPEND) -n "$@" \
946 ' &g_$(subst -,_,$(tolower $(patsubst man_%,%,$(notdir $(basename $(refentry)))))), ')
947 $(QUIET)$(APPEND) -n "$@" \
948 '};' \
949 'const uint32_t g_cHelpEntries = RT_ELEMENTS(g_apHelpEntries);' \
950 ''
951 $(QUIET)$(CP) --changed -- "$@" "$(patsubst %.ts,%,$@)"
952# The above APPEND stuff trigger some kind of problem on some boxes when not split up...
953# update: Fixed in SVN (strcpy -> memmove in new_job(), job.c - r2591). Just need to rebuild all platforms.
954
955$(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h.ts \
956+| $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h: \
957 $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-H-help.xsl \
958 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
959 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
960 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(filter %.xml,$^),$(patsubst %.ts,%,$@))
961 $(QUIET)$(APPEND) -tn "$@" \
962 '/* Autogenerated by $<, do not edit! */' \
963 '' \
964 '#ifndef ___VBoxManageBuiltInHelp_h___' \
965 '#define ___VBoxManageBuiltInHelp_h___' \
966 '' \
967 '#include <VBox/refentry.h>' \
968 '' \
969 'RT_C_DECLS_BEGIN' \
970 '' \
971 'typedef enum HELP_CMD_VBOXMANAGE' \
972 '{' \
973 ' HELP_CMD_VBOXMANAGE_INVALID = 0,'
974 $(foreach refentry,$(filter %.xml,$^) \
975 ,$(NLTAB)$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$@") \
976 --stringparam 'g_sMode' 'cmd' $< $(refentry))
977 $(QUIET)$(APPEND) -n "$@" \
978 ' HELP_CMD_VBOXMANAGE_END' \
979 '} HELP_CMD_VBOXMANAGE;'
980 $(foreach refentry,$(filter %.xml,$^) \
981 ,$(NLTAB)$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$@") \
982 --stringparam 'g_sMode' 'subcmd' $< $(refentry))
983 $(QUIET)$(APPEND) -n "$@" \
984 '' \
985 'extern PCREFENTRY g_apHelpEntries[];' \
986 'extern const uint32_t g_cHelpEntries;' \
987 '' \
988 'RT_C_DECLS_END' \
989 '' \
990 '#endif' \
991 ''
992 $(QUIET)$(CP) --changed -- "$@" "$(patsubst %.ts,%,$@)"
993
994
995include $(FILE_KBUILD_SUB_FOOTER)
996
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette