Makefile.kmk@ 63399

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format