Makefile.kmk@ 99016

Last change on this file since 99016 was 99014, checked in by vboxsync, 2 years ago
manual: Use the UserManual.ditamap instead of UserManual.xml to generate xslt for link replacement in manual pages. bugref:10302
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.9 KB

Line
1	# $Id: Makefile.kmk 99014 2023-03-17 15:34:57Z vboxsync $
2	## @file
3	# Sub-Makefile for the VirtualBox User Manual, SDK reference and other manuals.
4	#
5
6	#
7	# Copyright (C) 2006-2023 Oracle and/or its affiliates.
8	#
9	# This file is part of VirtualBox base platform packages, as
10	# available from https://www.virtualbox.org.
11	#
12	# This program is free software; you can redistribute it and/or
13	# modify it under the terms of the GNU General Public License
14	# as published by the Free Software Foundation, in version 3 of the
15	# License.
16	#
17	# This program is distributed in the hope that it will be useful, but
18	# WITHOUT ANY WARRANTY; without even the implied warranty of
19	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	# General Public License for more details.
21	#
22	# You should have received a copy of the GNU General Public License
23	# along with this program; if not, see <https://www.gnu.org/licenses>.
24	#
25	# SPDX-License-Identifier: GPL-3.0-only
26	#
27
28	#
29	# This slightly messy makefile transforms the DocBook XML source for the
30	# user manual into presentation output. We support two targets:
31	#
32	# -- UserManual.pdf, generated by LaTex
33	#
34	#
35	# Both files end up in PATH_STAGE_BIN.
36	#
37	# Both targets indirectly depend on the XML files in this directory;
38	# "indirectly" because we first copy them to PATH_TARGET and hack them
39	# up a bit for variable substitution and such (see below).
40	# The toolchains are roughly like this:
41	#
42	# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
43	# then create a .FO file (another XML format for "formatted objects")
44	# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
45	#
46	# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
47	# run our custom "dblatex" perl script on UserManual.xml, which parses
48	# the XML (using the Perl SAX parsers) and dumps a matching LaTeX file
49	# to UserManual.tex. This is then regularly processed by pdflatex to
50	# generate PDF.
51	#
52	#
53
54	SUB_DEPTH = ../..
55	include $(KBUILD_PATH)/subheader.kmk
56
57	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
58	include $(PATH_SUB_CURRENT)/Config.kmk
59	endif
60
61
62
63	#
64	# Globals
65	#
66
67	# Error out if someone tries to override old globals.
68	ifdef HTMLHELPOPTS
69	$(error HTMLHELPOPTS was renamed to VBOX_HTMLHELP_OPTS!)
70	endif
71	ifdef DOCBOOKPATH
72	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
73	endif
74	ifdef DOCBOOKPATH
75	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
76	endif
77	ifdef XML_CATALOG
78	$(error XML_CATALOG was renamed to VBOX_XML_CATALOG!)
79	endif
80	ifdef XML_CATALOG_DOCBOOK
81	$(error XML_CATALOG_DOCBOOK was renamed to VBOX_XML_CATALOG_DOCBOOK!)
82	endif
83	ifdef PDFLATEX_INTERACTION
84	$(error PDFLATEX_INTERACTION was renamed to VBOX_PDFLATEX_INTERACTION!)
85	endif
86	ifdef PDFLATEX
87	$(error PDFLATEX was renamed to VBOX_PDFLATEX_CMD!)
88	endif
89	ifdef HHC
90	$(error HHC was renamed to VBOX_HHC!)
91	endif
92
93	VBOX_DITA_PATH = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-1.8.5
94
95	VBOX_QHELP_OUTPUT_FILES = \
96	UserManual.qch \
97	UserManual.qhc
98
99	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
100	# without catting the log a million times.
101	VBOX_PDFLATEX_INTERACTION ?= batchmode
102	ifeq ($(KBUILD_HOST),win)
103	ifndef VBOX_PDFLATEX
104	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
105	ifneq ($(VBOX_PDFLATEX),)
106	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
107	endif
108	endif
109	ifndef VBOX_PDFLATEX
110	# Tell MiKTeX to automatically download packages if system wide install.
111	VBOX_PDFLATEX := pdflatex
112	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
113	endif
114	else
115	VBOX_PDFLATEX ?= pdflatex
116	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
117	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
118	endif
119
120	# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
121	VBOX_HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
122
123
124	# Additional xsltproc options when generating
125	VBOX_HTMLHELP_OPTS ?=
126
127	# SDK related globals.
128	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
129	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
130	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
131
132
133	#
134	# Targets
135	#
136
137	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
138
139	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
140	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
141	INSTALLS += VBox-docs-sdkref
142	endif
143
144	ifdef VBOX_WITH_DOCS_HTML
145	INSTALLS += VBox-docs-usermanual-html
146	VBOX_PATH_BIN_HTML = $(PATH_STAGE_BIN)/UserManual-html.zip
147	else # Do not build html.
148	VBOX_PATH_BIN_HTML =
149	endif
150
151	ifdef VBOX_WITH_DOCS_QHELP
152	INSTALLS += VBox-docs-usermanual-qhc
153	INSTALLS += VBox-docs-usermanual-qch
154	ifdef VBOX_WITH_QT6
155	USES += qt6
156	QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
157	else # Qt5
158	USES += qt5
159	QHELPGENERATOR_VERSION_MINOR = $(shell $(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$(PATH_SDK_QT5)/plugins -- $(PATH_TOOL_QT5_BIN)/qhelpgenerator -v 2>/dev/null \| $(SED) -ne 's/.(Qt [1-9][0-9]\.$[1-9][0-9]$\.[1-9][0-9]).*$$/\1/p')
160	QHELPGENERATOR = $(PATH_TOOL_QT5_BIN)/$(if-expr $(QHELPGENERATOR_VERSION_MINOR) >= 12,qhelpgenerator,qcollectiongenerator)
161	endif
162	endif
163	ifdef VBOX_WITH_DOCS_QHELP_PACKING
164	VBOX_PATH_BIN_QHELP = $(PATH_STAGE_BIN)/UserManual.qch
165	VBOX_PATH_BIN_QHELP += $(PATH_STAGE_BIN)/UserManual.qhc
166	else # Do not install/pack qhelp.
167	VBOX_PATH_BIN_QHELP =
168	endif
169
170	.NOTPARALLEL: \
171	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch + $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.qhc \
172	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf \
173	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
174
175	ifndef VBOX_ONLY_SDK
176	VBOX_MANUAL_PACK += \
177	$(PATH_STAGE_BIN)/UserManual.pdf \
178	$(VBOX_PATH_BIN_HTML) \
179	$(VBOX_PATH_BIN_CHM) \
180	$(VBOX_PATH_BIN_QHELP)
181	INSTALLS += VBox-docs-usermanual
182
183	ifdef VBOX_WITH_DOCS_TRANSLATIONS
184	INSTALLS += VBox-docs-usermanual-l10n
185	VBOX_MANUAL_PACK += \
186	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
187	endif
188	endif # !VBOX_ONLY_SDK
189
190	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
191	INSTALLS += VBox-docs-accessibility
192	INSTALLS += VBox-docs-accessibility-html
193	endif
194
195	ifdef VBOX_ONLY_DOCS
196	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
197	endif
198
199	ifdef VBOX_WITH_DOCS_TRANSLATIONS
200	VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
201	endif
202
203	$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
204	$(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \
205	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
206	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
207	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_VBoxHeadless.xml \
208	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_vboximg-mount.xml \
209	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_isomakercmd-man.xml))
210
211	VBOX_SDKREF_XML_FILES = \
212	SDKRef.xml
213
214	VBOX_ACCESSIBILITY_XML_FILES = \
215	Accessibility.xml
216
217
218	# Wildcard the images path for every supported language
219	$(foreach f,$(VBOX_MANUAL_LANGUAGES), \
220	$(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
221
222	VBOX_MANUAL_TEX_UNICODE_FILES = \
223	$(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
224
225	VBOX_MANUAL_LATEX_FILES_TARGET = \
226	$(addprefix UserManual.,aux log out toc tex)
227
228	VBOX_SDKREF_LATEX_FILES_TARGET = \
229	$(addprefix SDKRef.,aux log out toc tex)
230
231	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
232	$(addprefix Accessibility.,aux log out toc tex)
233
234	BLDDIRS += \
235	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
236	$(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
237	$(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
238	$(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
239	$(addsuffix /qhelp, $(VBOX_MANUAL_LANGUAGES)) \
240	$(addsuffix /qhelp/images, $(VBOX_MANUAL_LANGUAGES)) \
241	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
242	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
243	)
244
245	# Explicit cleaning has some overlap with default cleaning rules, since this
246	# Makefile is using very complex conditionals for selectively creating
247	# specific files, and not everyone remembers to use the same with "kmk clean".
248	OTHER_CLEAN += \
249	$(VBOX_XML_CATALOG) \
250	$(VBOX_XML_CATALOG_DOCBOOK) \
251	$(VBOX_XML_CATALOG_MANUAL) \
252	$(VBOX_XML_ENTITIES) \
253	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
254	$(VBOX_XML_XREF_TO_TEXT) \
255	$(VBOX_XML_XREF_TO_TEXT).cat \
256	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
257	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
258	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
259	man_VBoxHeadless.xml \
260	user_man_VBoxHeadless.xml \
261	man_vboximg-mount.xml \
262	user_man_vboximg-mount.xml \
263	isomakercmd-man.xml \
264	user_isomakercmd-man.xml \
265	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
266	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
267	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
268	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
269	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
270	html-single/UserManual.html \
271	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
272	$(addprefix HTMLHelp/, index.html go01.html) \
273	$(addprefix qhelp/, index.html go01.html) \
274	$(addprefix html-chunks/, index.html go01.html) \
275	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
276	,html-chunks/ch$(n).html \
277	html-chunks/re$(n).html \
278	HTMLHelp/ch$(n).html \
279	HTMLHelp/re$(n).html \
280	$(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)) \
281	qhelp/ch$(n).html \
282	qhelp/re$(n).html \
283	$(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,qhelp/ch$(n)s$(d2)$(d1).html)) ) \
284	$(foreach n,a b c \
285	,html-chunks/ap$(n).html \
286	HTMLHelp/ap$(n).html \
287	$(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) \
288	qhelp/ap$(n).html \
289	$(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,qhelp/ap$(n)s$(s).html) ) \
290	$(foreach n,01 02 03 04 05 \
291	,html-chunks/pr$(n).html \
292	HTMLHelp/pr$(n).html \
293	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
294	qhelp/pr$(n).html \
295	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
296	HTMLHelp/toc.hhc \
297	HTMLHelp/htmlhelp.hhp \
298	qhelp/toc.hhc \
299	qhelp/htmlhelp.hhp \
300	UserManual.pdf \
301	VirtualBox.chm \
302	$(VBOX_QHELP_OUTPUT_FILES) \
303	ChangeLog.html \
304	validatemanual.run \
305	validateaccessibility.run \
306	validatesdkref.run \
307	)) \
308	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
309	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
310	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
311	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
312	$(PATH_STAGE_BIN)/UserManual.pdf \
313	$(PATH_STAGE_BIN)/VirtualBox.chm \
314	\
315	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
316	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
317	SDKRef.pdf \
318	) \
319	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
320	\
321	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
322	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
323	html-single/Accessibility.html \
324	Accessibility.pdf \
325	) \
326	$(PATH_STAGE_BIN)/Accessibility.html \
327	$(PATH_STAGE_BIN)/Accessibility.pdf \
328	\
329	$(VBOX_DOC_XIDL_SRC_TMP) \
330	$(VBOX_MANUAL_APIREF_TMP)
331
332	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
333
334	#
335	# target for installing UserManual.pdf
336	#
337	VBox-docs-usermanual_INST = $(INST_BIN)
338	VBox-docs-usermanual_MODE = a+r,u+w
339	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
340
341	VBox-docs-usermanual-qhc_INST = $(INST_BIN)
342	VBox-docs-usermanual-qhc_MODE = a+r,u+w
343	VBox-docs-usermanual-qhc_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc
344
345	VBox-docs-usermanual-qch_INST = $(INST_BIN)
346	VBox-docs-usermanual-qch_MODE = a+r,u+w
347	VBox-docs-usermanual-qch_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
348
349	#
350	# target for installing translated UserManual_*.pdf
351	#
352	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
353	VBox-docs-usermanual-l10n_MODE = a+r,u+w
354	VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
355
356	#
357	# target for installing the chunked HTML docs
358	#
359	VBox-docs-usermanual-html_INST = $(INST_BIN)
360	VBox-docs-usermanual-html_MODE = a+r,u+w
361	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
362
363	#
364	# target for installing VirtualBox.chm
365	#
366	VBox-docs-usermanual-chm_INST = $(INST_BIN)
367	VBox-docs-usermanual-chm_MODE = a+r,u+w
368	VBox-docs-usermanual-chm_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
369
370	#
371	# target for installing translated VirtualBox_*.chm
372	#
373	VBox-docs-usermanual-l10n-chm_INST = $(INST_BIN)
374	VBox-docs-usermanual-l10n-chm_MODE = a+r,u+w
375	VBox-docs-usermanual-l10n-chm_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
376
377	#
378	# target for installing SDKRef.pdf
379	#
380	VBox-docs-sdkref_INST = $(INST_SDK)docs/
381	VBox-docs-sdkref_MODE = a+r,u+w
382	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
383
384	#
385	# target for installing Accessibility.pdf
386	#
387	VBox-docs-accessibility_INST = $(INST_BIN)
388	VBox-docs-accessibility_MODE = a+r,u+w
389	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
390
391	#
392	# target for installing Accessibility.html
393	#
394	VBox-docs-accessibility-html_INST = $(INST_BIN)
395	VBox-docs-accessibility-html_MODE = a+r,u+w
396	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
397
398	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
399
400	##
401	# Morph man pages into manual sections.
402	# $(evalcall2 def_vbox_refentry_to_user_sect1)
403	# @param 1 Language.
404	# @param 2 the refentry xml base file name.
405	# @param 3 the full refentry xml file path.
406	define def_vbox_refentry_to_user_sect1
407	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
408	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
409	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
410	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
411	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
412	$$(QUIET)$$(RM) -f "$$@"
413	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
414	endef
415	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
416	man_VBoxHeadless.xml \
417	man_vboximg-mount.xml \
418	, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
419	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
420	,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
421
422
423	# Generates the VBoxManage command overview include file (shared between
424	# languages) from the refsynopsisdiv section of the man pages.
425	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
426	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
427	$$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
428	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
429	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
430	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
431	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
432
433
434
435
436
437	##########################################################################################
438	#
439	# Shared rules for PDF generation
440	#
441	##########################################################################################
442
443	ifndef VBOX_OSE
444	# copy ucs.sty and related files
445	$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
446	$(call MSG_L1,Copying unicode support for LaTeX)
447	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
448	endif
449
450	# copy the PNG files.
451	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
452	define def_vbox_cp_images_pdf
453	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
454	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
455	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
456	$$(call MSG_L1,Copying temporary $$< => $$@)
457	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
458	endef
459	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
460
461
462	##########################################################################################
463	#
464	# UserManual.pdf
465	#
466	##########################################################################################
467
468	ifdef TO_BE_REMOVED
469	# Generate PDF from LaTeX
470	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
471	define def_vbox_usermanual_tex_to_pdf
472	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
473	$$(out_dir)/UserManual.pdf: \
474	$$(out_dir)/UserManual.tex \
475	$$(if $$(VBOX_OSE),,$$(out_dir)/ucs.sty) \
476	$$(addprefix $$(out_dir)/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \| $$$$(dir $$$$@)
477	# PDF generation via Latex: generate the .tex file
478	$$(call MSG_L1,pdflatex $$< (four passes) -> $$@)
479	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
480	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
481	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
482	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
483	$$(QUIET)$$(SED) -ne '/Warning: Hyper reference/p' $$(basename $$<).log
484	$$(QUIET)$$(SED) -n \
485	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
486	$$(basename $$@).log
487	$$(call MSG_L1,Fresh LaTeX-generated PDF is now at $$@)
488	endef
489	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_tex_to_pdf))
490
491	# Generate LaTeX from XML
492	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
493	define def_vbox_usermanual_xml_to_tex
494	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
495	$$(out_dir)/UserManual.tex: \
496	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
497	$$(VBOX_MANUAL_XML_FILES_COMMON) \
498	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
499	$$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
500	$$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
501	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
502	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
503	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(firstword $$(filter %.xml,$$^)),$$@)
504	$$(QUIET)$$(RM) -f $$(addprefix $$(@D)/,$$(VBOX_MANUAL_LATEX_FILES_TARGET))
505	# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
506	# pass current language to xsltproc in TARGETLANG variable
507	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(lang) \
508	-o $$@.tmp $$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $$<
509	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
510	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
511	$$(QUIET)$$(SED) \
512	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
513	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
514	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
515	--output $$@ $$@.tmp
516	$$(QUIET)$$(RM) -f $$@.tmp
517	endef
518	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_tex))
519	endif # TO_BE_REMOVED
520	# Useful aliases
521	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
522
523	debug-usermanual:
524	$(MAKE) --pretty-command-printing -j1 VBOX_PDFLATEX_INTERACTION=errorstopmode $(PATH_STAGE_BIN)/UserManual.pdf
525
526	ifdef TO_BE_REMOVED
527	#
528	# Generate rules for validating the UserManual.xml. These are invoked
529	# automatically at build time, but can also be manually invoked via the
530	# 'validatemanual' and 'validatemanual_<lang>' aliases.
531	#
532	define def_vbox_validate_xml
533	validatemanual_$(lang):: $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run
534	$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run: \
535	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
536	$$(VBOX_MANUAL_XML_FILES_COMMON) \
537	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
538	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
539	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
540	$$(call MSG_L1,Validating $$<)
541	$$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
542	$$(QUIET)$$(APPEND) -t "$$@" "done"
543	endef
544	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_validate_xml))
545
546
547	# Handy aliases.
548	validatemanual:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),validatemanual_$(lang))
549	endif # TO_BE_REMOVED
550
551
552	#
553	# SDKRef.pdf
554	#
555
556	# Replace <tt> tags in VirtualBox.xidl.
557	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
558	$(call MSG_L1,Generating $@)
559	$(QUIET)$(SED) -e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
560	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
561	--output $@ $<
562
563	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
564	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
565	$(call MSG_L1,Generating $@)
566	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
567
568	# Turn SDKRef.xml into LaTeX.
569	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
570	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
571	$(VBOX_MANUAL_APIREF_TMP) \
572	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
573	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
574	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
575	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
576	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
577	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
578	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
579	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
580	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
581	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
582	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
583	$(QUIET)$(SED) \
584	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
585	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
586	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
587	--output $@ $@.tmp
588	$(QUIET)$(RM) -f $@.tmp
589
590	# Turn SDKRef.tex into a PDF.
591	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
592	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
593	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
594	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
595	$(call MSG_L1,pdflatex $< (three passes))
596	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
597	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
598	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
599	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
600	$(QUIET)$(SED) -n \
601	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
602	$(basename $<).log
603	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
604
605	# Validating SDKRef.xml. It is invoked automatically at build time,
606	# but can also be manually invoked via the 'validate-sdkref' alias.
607	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
608	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
609	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
610	$(VBOX_MANUAL_APIREF_TMP) \
611	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
612	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
613	$(call MSG_L1,Validating $<)
614	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
615	$(QUIET)$(APPEND) -t "$@" "done"
616
617
618	# Handy aliases.
619	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
620	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
621
622
623
624	#
625	# Accessibility.pdf
626	#
627
628	# Turn Accessibility.xml into LaTeX.
629	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
630	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
631	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
632	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
633	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
634	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
635	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
636	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
637	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
638	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
639	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
640	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
641	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
642	$(QUIET)$(SED) \
643	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
644	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
645	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
646	--output $@ $@.tmp
647	$(QUIET)$(RM) -f $@.tmp
648
649	# Turn Accessibility.tex into a PDF.
650	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
651	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
652	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
653	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
654	$(call MSG_L1,pdflatex $< (three passes))
655	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
656	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
657	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
658	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
659	$(QUIET)$(SED) -n \
660	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
661	$(basename $<).log
662	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
663
664	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
665	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
666	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
667	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
668	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
669	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
670	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
671	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
672	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
673	$<
674
675	# Validating Accessibility.xml. It is invoked automatically at build time,
676	# but can also be manually invoked via the 'validate-accessibility' alias.
677	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
678	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
679	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
680	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
681	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
682	$(call MSG_L1,Validating $<)
683	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
684	$(QUIET)$(APPEND) -t "$@" "done"
685
686
687	# Handy aliases.
688	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
689	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
690	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
691
692
693	# A few things which are shared between htmlhelp and qhelp docs.
694	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
695	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
696	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
697	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
698
699	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
700	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
701	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
702	$(call MSG_L1,xsltproc $<)
703	$(QUIET)$(RM) -f $@.tmp $@
704	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o $@.tmp $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
705	$(QUIET)$(MV) -f $@.tmp $@
706
707	# Packing the docs into a zip file
708	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
709	$(call MSG_L1,Packing documentation $@)
710	$(QUIET)$(RM) -f $@
711	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
712
713
714	##########################################################################################
715	#
716	# UserManual.html
717	#
718	##########################################################################################
719
720	ifdef TO_BE_REMOVED
721	VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
722	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
723	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
724	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
725
726	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
727	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
728	$(VBOX_MANUAL_XML_FILES_COMMON) \
729	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
730	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
731	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
732	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
733	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
734	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
735	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
736	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
737	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
738	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
739	$<
740
741	VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
742	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
743	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
744	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
745
746	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
747	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
748	$(VBOX_MANUAL_XML_FILES_COMMON) \
749	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
750	$(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
751	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
752	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
753	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
754	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
755	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
756	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
757	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
758	--stringparam chunk.section.depth 0 \
759	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
760	$<
761
762	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
763	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
764	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
765	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
766	$(call MSG_L1,Packing documentation $@)
767	$(QUIET)$(RM) -f $@
768	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
769	-9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
770	endif # TO_BE_REMOVED
771
772	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
773	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
774	$(call MSG_L1,Packing documentation $@)
775	$(QUIET)$(RM) -f $@
776	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
777	-9 -r $@ html-chunks
778
779	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
780	dita_common
781	$(call MSG_L1,Building html chunks $@)
782	$(QUIET)$(call VBOX_DITA_ENV_SETUP) \
783	$(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
784	/transtype:xhtml /ditadir:$(VBOX_DITA_PATH) /outdir:$(@D) /tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml
785
786	# disable for now
787	#html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
788	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
789	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
790	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
791
792	##########################################################################################
793	#
794	# DITA stuff common to pdf, qhelp, and html outputs.
795	# - copy DITA-OT library (binaries etc) since at each run several run-time config
796	# files are updated.
797	# - create dita/topic folder and copy all user manual dita files under that.
798	# - copy all images under dita/topics/images and UserManual.ditamap under dita folder
799	# - copy all man_VBox???.xml docbook files under dita/topic folder.
800	# - flatten refsect1/refsect2 hierarchy in man_VBox???.xml docbook files by
801	# using refsect2_to_refsect1.py.
802	# - convert man_VBox???.xml files into dita files
803	# - mark external link in the man_VBox????.dita files
804	# - correct all reference targets by calling correct_references.py.
805	#
806	##########################################################################################
807
808	VBOX_USER_MANUAL_DITA_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)
809	VBOX_USER_MANUAL_DITA_IMAGES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)
810
811	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap:
812	$(QUIET)$(MKDIR) -p $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
813	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/dita/UserManual.ditamap "$(@D)"
814	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_FILES) "$(@D)/topics"
815	$(QUIET)touch -- "$(@D)/topics/reference.dtd"
816	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_IMAGES) "$(@D)/topics/images"
817
818	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml:
819	$(QUIET)$(MKDIR) -p $(dir $@)
820	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/$(notdir $@) "$(@D)"
821
822	correct_reference_targets: \
823	$$(VBOX_PATH_MANUAL_SRC)/correct_references.py \
824	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/ \
825	$$(VBOX_REFENTRY_DITA_FILES)
826	$(call MSG_L1,correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics)
827	$(QUIET)$(VBOX_BLD_PYTHON) $(VBOX_PATH_MANUAL_SRC)/correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics
828
829	dita_common: \
830	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
831	$$(VBOX_DITA_PATH) \
832	correct_reference_targets
833	$(call MSG_L1, Running common dita steps)
834
835	##########################################################################################
836	#
837	# Docbook to Dita conversion of our refentry files
838	#
839	##########################################################################################
840	define def_vbox_refentry_to_dita
841	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(addsuffix .dita,$(basename $(2))): \
842	$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
843	$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
844	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml \
845	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
846	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
847
848	$$(QUIET)$$(RM) -f "$$@"
849	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/refsect2_to_refsect1.py -i $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) -o $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)
850	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
851	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)
852	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl $$@
853	endef
854	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount.xml man_VBoxHeadless.xml \
855	, $(evalcall2 def_vbox_refentry_to_dita,$(lang),$(file))))
856
857	VBOX_REFENTRY_DITA_FILES = $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES)) \
858	man_vboximg-mount man_VBoxHeadless user_isomakercmd-man \
859	,$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/$(file).dita))
860
861	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita: \
862	$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
863	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml \| $$(dir $$@)
864	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $@ $(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml
865
866	##########################################################################################
867	#
868	# Use DITA-OT to create pdf/hhp out of UserManual.ditamap. See usermanual.pdf under
869	# DITA-OT-xxxxx/doc folder for details.
870	#
871	##########################################################################################
872	# Copy the dita library under out folder since at each use the library modifies some
873	# run-time configuation files.
874	$(VBOX_DITA_PATH):
875	$(MKDIR) -p $(VBOX_DITA_PATH)
876	cp -R $(VBOX_DITA_ORIGINAL_PATH)/* $(VBOX_DITA_PATH)/
877
878	VBOX_DITA_PATH_LIB ?= $(VBOX_DITA_PATH)/lib
879	VBOX_DITA_ENV_SETUP ?= $(REDIRECT) \
880	-E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
881	-E 'ANT_HOME=$(VBOX_DITA_PATH)/tools/ant' \
882	-E 'DITA_DIR=$(VBOX_DITA_PATH)' \
883	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
884	-A 'PATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH)/tools/ant/bin' \
885	-E 'CLASSPATH=$(VBOX_DITA_PATH_LIB)/dost.jar' \
886	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)' \
887	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/commons-codec-1.4.jar' \
888	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/resolver.jar' \
889	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/icu4j.jar' \
890	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xercesImpl.jar' \
891	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xml-apis.jar' \
892	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9.jar' \
893	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9-dom.jar' \
894	--
895
896	define def_ditamap_to_pdf
897	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
898	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf: \
899	$$(VBOX_MANUAL_XML_FILES_COMMON) \
900	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
901	dita_common
902	$(QUIET)$(call VBOX_DITA_ENV_SETUP) \
903	$(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
904	/transtype:pdf /ditadir:$(VBOX_DITA_PATH) /outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1) /tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf
905
906	endef
907	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
908
909	#
910	# ChangeLog.html
911	#
912	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
913	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
914	#
915	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
916	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
917	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
918	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
919	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
920	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
921	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
922	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
923
924	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
925
926
927
928	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
929
930
931	#
932	# VBoxManage man pages (parts also required by VBoxManage built-in help).
933	#
934
935	##
936	# Emits rules for preprocessing refentry sources (applying remarks element),
937	# and for producing the actual man pages.
938	# $(evalcall2 def_vbox_refentry_to_manpage)
939	# @param 1 The language
940	# @param 2 The file name (no path).
941	define def_vbox_refentry_to_manpage
942	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
943	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
944	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
945	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
946	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
947	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
948	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
949	$$(QUIET)$$(RM) -f "$$@"
950	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
951	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
952	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@.tmp $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
953	$$(QUIET)$$(MV) -f -- "$$@.tmp" "$$@"
954	if defined(VBOX_HAVE_XMLLINT)
955	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
956	endif
957
958	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
959	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
960	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
961	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
962	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
963	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
964	$$(QUIET)$$(RM) -f "$$@"
965	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
966	endef
967	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
968	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
969
970	ifdef VBOX_WITH_DOCS_QHELP
971	#
972	# VirtualBox.qch/VirtualBox.qhc
973	#
974	# We first generate a .hhp help source file from the preprocessed
975	# DocBook XML files, as defined above, then feed that into a converter
976	# creating the suitable input for creating a QHelp collection file.
977
978	# Generate QCH from QHelp source
979	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
980	define def_vbox_usermanual_qhp_to_qch
981	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
982	$$(out_dir)/qhelp/UserManual.qch + \
983	$$(out_dir)/qhelp/UserManual.qhc: \
984	$$(out_dir)/qhelp/UserManual.qhcp \
985	$$(out_dir)/qhelp/UserManual.qhp \
986	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
987	\| $$$$(dir $$$$@)
988	$$(call MSG_L1,$$(notdir $$(QHELPGENERATOR)) $$<,=> $$@)
989	$$(QUIET)$$(RM) -f $$@
990	$$(QUIET)$$(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT5)/plugins -- $$(QHELPGENERATOR) $$<
991	$$(call MSG_L1,Fresh QCH is now at $$@)
992	endef
993	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_qhp_to_qch))
994
995	# Generate QHP from HHP for QHelp
996	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
997	define def_vbox_usermanual_hhp_qhelp_to_qhp
998	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
999	$$(out_dir)/qhelp/UserManual.qhp: \
1000	$$(out_dir)/qhelp/UserManual.hhp \
1001	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
1002	\| $$$$(dir $$$$@)
1003	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
1004	$$(QUIET)$$(RM) -f $$@
1005	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py -d $$(<D) -o $$@ -f UserManual.hhp -t UserManual.hhc
1006	endef
1007	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_qhelp_to_qhp))
1008
1009
1010	define def_ditamap_to_htmlhelp
1011	ditamap-to-htmlhelp: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp
1012	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp: \
1013	dita_common
1014	$(QUIET)$(call VBOX_DITA_ENV_SETUP) \
1015	$(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
1016	/transtype:htmlhelp /ditadir:$(VBOX_DITA_PATH) /outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp /tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_htmlhelp
1017
1018	endef
1019	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_htmlhelp,$(lang)))
1020
1021	# copy the qhcp file.
1022	define def_vbox_cp_qhcp
1023	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
1024	$$(out_dir)/UserManual.qhcp: \
1025	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/% \| $$$$(dir $$$$@)
1026	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1027	endef
1028	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_qhcp)))
1029
1030	# copy the PNG files.
1031	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
1032	define def_vbox_cp_images_qhelp
1033	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
1034	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
1035	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
1036	$$(call MSG_L1,Copying temporary $$< => $$@)
1037	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1038	endef
1039	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_qhelp)))
1040
1041	endif # VBOX_WITH_DOCS_QHELP
1042
1043	# Handy aliases.
1044	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
1045	man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1046	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
1047
1048	#
1049	# Manually updating the DHCP option list taken from VirtualBox.xidl
1050	#
1051	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
1052	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
1053	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
1054
1055
1056	include $(FILE_KBUILD_SUB_FOOTER)
1057

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

Download in other formats:

Original Format