Makefile.kmk@ 99033

Last change on this file since 99033 was 99033, checked in by vboxsync, 2 years ago
manual/Makefile.kmk: dita_common and correct_reference_targets must be real files, or anyone depending on them will always be remade as stat() fails. Various cleanups. bugref:10302
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.5 KB

Line
1	# $Id: Makefile.kmk 99033 2023-03-17 22:14:59Z 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-qhelp
153	ifdef VBOX_WITH_QT6
154	USES += qt6
155	QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
156	else # Qt5
157	USES += qt5
158	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')
159	QHELPGENERATOR = $(PATH_TOOL_QT5_BIN)/$(if-expr $(QHELPGENERATOR_VERSION_MINOR) >= 12,qhelpgenerator,qcollectiongenerator)
160	endif
161	endif
162	ifdef VBOX_WITH_DOCS_QHELP_PACKING
163	VBOX_PATH_BIN_QHELP = \
164	$(PATH_STAGE_BIN)/UserManual.qch \
165	$(PATH_STAGE_BIN)/UserManual.qhc
166	else # Do not install/pack qhelp.
167	VBOX_PATH_BIN_QHELP :=
168	endif
169
170	## @todo r=bird: Explanations for all of this is required!
171	.NOTPARALLEL: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch \
172	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.qhc \
173	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf \
174	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
175
176	ifndef VBOX_ONLY_SDK
177	VBOX_MANUAL_PACK += \
178	$(PATH_STAGE_BIN)/UserManual.pdf \
179	$(VBOX_PATH_BIN_HTML) \
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-qhelp_INST = $(INST_BIN)
342	VBox-docs-usermanual-qhelp_MODE = a+r,u+w
343	VBox-docs-usermanual-qhelp_SOURCES = \
344	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc \
345	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
346
347	#
348	# target for installing translated UserManual_*.pdf
349	#
350	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
351	VBox-docs-usermanual-l10n_MODE = a+r,u+w
352	VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
353
354	#
355	# target for installing the chunked HTML docs
356	#
357	VBox-docs-usermanual-html_INST = $(INST_BIN)
358	VBox-docs-usermanual-html_MODE = a+r,u+w
359	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
360
361	#
362	# target for installing SDKRef.pdf
363	#
364	VBox-docs-sdkref_INST = $(INST_SDK)docs/
365	VBox-docs-sdkref_MODE = a+r,u+w
366	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
367
368	#
369	# target for installing Accessibility.pdf
370	#
371	VBox-docs-accessibility_INST = $(INST_BIN)
372	VBox-docs-accessibility_MODE = a+r,u+w
373	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
374
375	#
376	# target for installing Accessibility.html
377	#
378	VBox-docs-accessibility-html_INST = $(INST_BIN)
379	VBox-docs-accessibility-html_MODE = a+r,u+w
380	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
381
382	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
383
384	##
385	# Morph man pages into manual sections.
386	# $(evalcall2 def_vbox_refentry_to_user_sect1)
387	# @param 1 Language.
388	# @param 2 the refentry xml base file name.
389	# @param 3 the full refentry xml file path.
390	define def_vbox_refentry_to_user_sect1
391	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
392	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
393	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
394	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
395	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
396	$$(QUIET)$$(RM) -f "$$@"
397	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
398	endef
399	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
400	man_VBoxHeadless.xml \
401	man_vboximg-mount.xml \
402	, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
403	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
404	,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
405
406
407	# Generates the VBoxManage command overview include file (shared between
408	# languages) from the refsynopsisdiv section of the man pages.
409	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
410	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
411	$$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
412	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
413	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
414	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
415	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
416
417
418
419
420
421	##########################################################################################
422	#
423	# Shared rules for PDF generation
424	#
425	##########################################################################################
426
427	ifndef VBOX_OSE
428	# copy ucs.sty and related files
429	$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
430	$(call MSG_L1,Copying unicode support for LaTeX)
431	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
432	endif
433
434	# copy the PNG files.
435	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
436	define def_vbox_cp_images_pdf
437	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
438	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
439	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
440	$$(call MSG_L1,Copying temporary $$< => $$@)
441	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
442	endef
443	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
444
445
446	##########################################################################################
447	#
448	# UserManual.pdf
449	#
450	##########################################################################################
451
452	ifdef TO_BE_REMOVED
453	# Generate PDF from LaTeX
454	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
455	define def_vbox_usermanual_tex_to_pdf
456	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
457	$$(out_dir)/UserManual.pdf: \
458	$$(out_dir)/UserManual.tex \
459	$$(if $$(VBOX_OSE),,$$(out_dir)/ucs.sty) \
460	$$(addprefix $$(out_dir)/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \| $$$$(dir $$$$@)
461	# PDF generation via Latex: generate the .tex file
462	$$(call MSG_L1,pdflatex $$< (four passes) -> $$@)
463	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
464	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
465	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
466	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
467	$$(QUIET)$$(SED) -ne '/Warning: Hyper reference/p' $$(basename $$<).log
468	$$(QUIET)$$(SED) -n \
469	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
470	$$(basename $$@).log
471	$$(call MSG_L1,Fresh LaTeX-generated PDF is now at $$@)
472	endef
473	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_tex_to_pdf))
474
475	# Generate LaTeX from XML
476	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
477	define def_vbox_usermanual_xml_to_tex
478	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
479	$$(out_dir)/UserManual.tex: \
480	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
481	$$(VBOX_MANUAL_XML_FILES_COMMON) \
482	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
483	$$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
484	$$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
485	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
486	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
487	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(firstword $$(filter %.xml,$$^)),$$@)
488	$$(QUIET)$$(RM) -f $$(addprefix $$(@D)/,$$(VBOX_MANUAL_LATEX_FILES_TARGET))
489	# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
490	# pass current language to xsltproc in TARGETLANG variable
491	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(lang) \
492	-o [email protected] $$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $$<
493	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
494	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
495	$$(QUIET)$$(SED) \
496	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
497	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
498	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
499	--output $$@ [email protected]
500	$$(QUIET)$$(RM) -f [email protected]
501	endef
502	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_tex))
503	endif # TO_BE_REMOVED
504	# Useful aliases
505	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
506
507	debug-usermanual:
508	$(MAKE) --pretty-command-printing -j1 VBOX_PDFLATEX_INTERACTION=errorstopmode $(PATH_STAGE_BIN)/UserManual.pdf
509
510	ifdef TO_BE_REMOVED
511	#
512	# Generate rules for validating the UserManual.xml. These are invoked
513	# automatically at build time, but can also be manually invoked via the
514	# 'validatemanual' and 'validatemanual_<lang>' aliases.
515	#
516	define def_vbox_validate_xml
517	validatemanual_$(lang):: $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run
518	$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run: \
519	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
520	$$(VBOX_MANUAL_XML_FILES_COMMON) \
521	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
522	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
523	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
524	$$(call MSG_L1,Validating $$<)
525	$$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
526	$$(QUIET)$$(APPEND) -t "$$@" "done"
527	endef
528	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_validate_xml))
529
530
531	# Handy aliases.
532	validatemanual:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),validatemanual_$(lang))
533	endif # TO_BE_REMOVED
534
535
536	#
537	# SDKRef.pdf
538	#
539
540	# Replace <tt> tags in VirtualBox.xidl.
541	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
542	$(call MSG_L1,Generating $@)
543	$(QUIET)$(SED) -e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
544	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
545	--output $@ $<
546
547	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
548	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
549	$(call MSG_L1,Generating $@)
550	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
551
552	# Turn SDKRef.xml into LaTeX.
553	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
554	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
555	$(VBOX_MANUAL_APIREF_TMP) \
556	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
557	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
558	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
559	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
560	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
561	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
562	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
563	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
564	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
565	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
566	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
567	$(QUIET)$(SED) \
568	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
569	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
570	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
571	--output $@ [email protected]
572	$(QUIET)$(RM) -f [email protected]
573
574	# Turn SDKRef.tex into a PDF.
575	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
576	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
577	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
578	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
579	$(call MSG_L1,pdflatex $< (three passes))
580	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
581	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
582	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
583	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
584	$(QUIET)$(SED) -n \
585	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
586	$(basename $<).log
587	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
588
589	# Validating SDKRef.xml. It is invoked automatically at build time,
590	# but can also be manually invoked via the 'validate-sdkref' alias.
591	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
592	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
593	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
594	$(VBOX_MANUAL_APIREF_TMP) \
595	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
596	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
597	$(call MSG_L1,Validating $<)
598	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
599	$(QUIET)$(APPEND) -t "$@" "done"
600
601
602	# Handy aliases.
603	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
604	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
605
606
607
608	#
609	# Accessibility.pdf
610	#
611
612	# Turn Accessibility.xml into LaTeX.
613	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
614	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
615	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
616	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
617	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
618	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
619	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
620	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
621	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
622	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
623	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
624	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
625	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
626	$(QUIET)$(SED) \
627	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
628	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
629	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
630	--output $@ [email protected]
631	$(QUIET)$(RM) -f [email protected]
632
633	# Turn Accessibility.tex into a PDF.
634	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
635	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
636	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
637	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
638	$(call MSG_L1,pdflatex $< (three passes))
639	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
640	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
641	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
642	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
643	$(QUIET)$(SED) -n \
644	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
645	$(basename $<).log
646	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
647
648	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
649	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
650	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
651	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
652	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
653	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
654	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
655	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
656	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
657	$<
658
659	# Validating Accessibility.xml. It is invoked automatically at build time,
660	# but can also be manually invoked via the 'validate-accessibility' alias.
661	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
662	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
663	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
664	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
665	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
666	$(call MSG_L1,Validating $<)
667	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
668	$(QUIET)$(APPEND) -t "$@" "done"
669
670
671	# Handy aliases.
672	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
673	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
674	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
675
676
677	# A few things which are shared between htmlhelp and qhelp docs.
678	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
679	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
680	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
681	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
682
683	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
684	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
685	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
686	$(call MSG_L1,xsltproc $<)
687	$(QUIET)$(RM) -f [email protected] $@
688	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
689	$(QUIET)$(MV) -f [email protected] $@
690
691	# Packing the docs into a zip file
692	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
693	$(call MSG_L1,Packing documentation $@)
694	$(QUIET)$(RM) -f $@
695	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
696
697
698	##########################################################################################
699	#
700	# UserManual.html
701	#
702	##########################################################################################
703
704	ifdef TO_BE_REMOVED
705	VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
706	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
707	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
708	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
709
710	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
711	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
712	$(VBOX_MANUAL_XML_FILES_COMMON) \
713	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
714	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
715	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
716	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
717	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
718	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
719	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
720	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
721	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
722	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
723	$<
724
725	VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
726	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
727	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
728	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
729
730	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
731	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
732	$(VBOX_MANUAL_XML_FILES_COMMON) \
733	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
734	$(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
735	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
736	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
737	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
738	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
739	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
740	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
741	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
742	--stringparam chunk.section.depth 0 \
743	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
744	$<
745
746	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
747	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
748	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
749	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
750	$(call MSG_L1,Packing documentation $@)
751	$(QUIET)$(RM) -f $@
752	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
753	-9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
754	endif # TO_BE_REMOVED
755
756	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
757	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
758	$(call MSG_L1,Packing documentation $@)
759	$(QUIET)$(RM) -f $@
760	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
761	-9 -r $@ html-chunks
762
763	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
764	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
765	$(call MSG_L1,Building html chunks $@)
766	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
767	/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
768	/transtype:xhtml \
769	/ditadir:$(VBOX_DITA_PATH) \
770	/outdir:$(@D) \
771	/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml
772
773	# disable for now
774	#html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
775	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
776	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
777	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
778
779	##########################################################################################
780	#
781	# DITA stuff common to pdf, qhelp, and html outputs.
782	# - copy DITA-OT library (binaries etc) since at each run several run-time config
783	# files are updated.
784	# - create dita/topic folder and copy all user manual dita files under that.
785	# - copy all images under dita/topics/images and UserManual.ditamap under dita folder
786	# - copy all man_VBox???.xml docbook files under dita/topic folder.
787	# - flatten refsect1/refsect2 hierarchy in man_VBox???.xml docbook files by
788	# using refsect2_to_refsect1.py.
789	# - convert man_VBox???.xml files into dita files
790	# - mark external link in the man_VBox????.dita files
791	# - correct all reference targets by calling correct_references.py.
792	#
793	##########################################################################################
794
795	VBOX_USER_MANUAL_DITA_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)
796	VBOX_USER_MANUAL_DITA_IMAGES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)
797
798	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap:
799	$(QUIET)$(MKDIR) -p $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
800	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/dita/UserManual.ditamap "$(@D)"
801	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_FILES) "$(@D)/topics"
802	$(QUIET)touch -- "$(@D)/topics/reference.dtd"
803	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_IMAGES) "$(@D)/topics/images"
804
805	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml:
806	$(QUIET)$(MKDIR) -p $(dir $@)
807	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/$(notdir $@) "$(@D)"
808
809	$(VBOX_PATH_MANUAL_OUTBASE)/correct_reference_targets: \
810	$$(VBOX_PATH_MANUAL_SRC)/correct_references.py \
811	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/ \
812	$$(VBOX_REFENTRY_DITA_FILES)
813	$(call MSG_L1,correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics)
814	$(QUIET)$(VBOX_BLD_PYTHON) $(VBOX_PATH_MANUAL_SRC)/correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics
815	$(QUIET)$(TOUCH) -- "$@"
816
817	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common: \
818	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
819	$$(VBOX_DITA_PATH) \
820	$(VBOX_PATH_MANUAL_OUTBASE)/correct_reference_targets
821	$(call MSG_L1, Running common dita steps)
822	$(QUIET)$(TOUCH) -- "$@"
823
824
825	##########################################################################################
826	#
827	# Docbook to Dita conversion of our refentry files
828	#
829	##########################################################################################
830	define def_vbox_refentry_to_dita
831	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(addsuffix .dita,$(basename $(2))): \
832	$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
833	$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
834	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml \
835	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
836	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
837
838	$$(QUIET)$$(RM) -f "$$@"
839	$$(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)
840	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
841	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)
842	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl $$@
843	endef
844	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount.xml man_VBoxHeadless.xml \
845	, $(evalcall2 def_vbox_refentry_to_dita,$(lang),$(file))))
846
847	VBOX_REFENTRY_DITA_FILES = $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES)) \
848	man_vboximg-mount man_VBoxHeadless user_isomakercmd-man \
849	,$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/$(file).dita))
850
851	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita: \
852	$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
853	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml \| $$(dir $$@)
854	$(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
855
856	##########################################################################################
857	#
858	# Use DITA-OT to create pdf/hhp out of UserManual.ditamap. See usermanual.pdf under
859	# DITA-OT-xxxxx/doc folder for details.
860	#
861	##########################################################################################
862	# Copy the dita library under out folder since at each use the library modifies some
863	# run-time configuation files.
864	$(VBOX_DITA_PATH):
865	$(MKDIR) -p $(VBOX_DITA_PATH)
866	cp -R $(VBOX_DITA_ORIGINAL_PATH)/* $(VBOX_DITA_PATH)/
867
868	VBOX_DITA_PATH_LIB ?= $(VBOX_DITA_PATH)/lib
869	VBOX_DITA_ENV_SETUP ?= $(REDIRECT) \
870	-E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
871	-E 'ANT_HOME=$(VBOX_DITA_PATH)/tools/ant' \
872	-E 'DITA_DIR=$(VBOX_DITA_PATH)' \
873	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
874	-A 'PATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH)/tools/ant/bin' \
875	-E 'CLASSPATH=$(VBOX_DITA_PATH_LIB)/dost.jar' \
876	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)' \
877	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/commons-codec-1.4.jar' \
878	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/resolver.jar' \
879	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/icu4j.jar' \
880	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xercesImpl.jar' \
881	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xml-apis.jar' \
882	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9.jar' \
883	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9-dom.jar' \
884	--
885
886	define def_ditamap_to_pdf
887	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
888	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf: \
889	$$(VBOX_MANUAL_XML_FILES_COMMON) \
890	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
891	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
892	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
893	/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
894	/transtype:pdf \
895	/ditadir:$(VBOX_DITA_PATH) \
896	/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1) \
897	/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf
898
899
900	endef
901	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
902
903	#
904	# ChangeLog.html
905	#
906	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
907	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
908	#
909	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
910	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
911	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
912	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
913	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
914	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
915	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
916	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
917
918	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
919
920
921
922	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
923
924
925	#
926	# VBoxManage man pages (parts also required by VBoxManage built-in help).
927	#
928
929	##
930	# Emits rules for preprocessing refentry sources (applying remarks element),
931	# and for producing the actual man pages.
932	# $(evalcall2 def_vbox_refentry_to_manpage)
933	# @param 1 The language
934	# @param 2 The file name (no path).
935	define def_vbox_refentry_to_manpage
936	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
937	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
938	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
939	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
940	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
941	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
942	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
943	$$(QUIET)$$(RM) -f "$$@"
944	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
945	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
946	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
947	$$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
948	if defined(VBOX_HAVE_XMLLINT)
949	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
950	endif
951
952	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
953	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
954	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
955	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
956	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
957	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
958	$$(QUIET)$$(RM) -f "$$@"
959	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
960	endef
961	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
962	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
963
964	ifdef VBOX_WITH_DOCS_QHELP
965	#
966	# VirtualBox.qch/VirtualBox.qhc
967	#
968	# We first generate a .hhp help source file from the preprocessed
969	# DocBook XML files, as defined above, then feed that into a converter
970	# creating the suitable input for creating a QHelp collection file.
971
972	# Generate QCH from QHelp source
973	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
974	define def_vbox_usermanual_qhp_to_qch
975	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
976	$$(out_dir)/qhelp/UserManual.qch \
977	+ $$(out_dir)/qhelp/UserManual.qhc: \
978	$$(out_dir)/qhelp/UserManual.qhcp \
979	$$(out_dir)/qhelp/UserManual.qhp \
980	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
981	\| $$$$(dir $$$$@)
982	$$(call MSG_L1,$$(notdir $$(QHELPGENERATOR)) $$<,=> $$@)
983	$$(QUIET)$$(RM) -f $$@
984	$$(QUIET)$$(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT5)/plugins -- $$(QHELPGENERATOR) $$<
985	$$(call MSG_L1,Fresh QCH is now at $$@)
986	endef
987	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_qhp_to_qch))
988
989	# Generate QHP from HHP for QHelp
990	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
991	define def_vbox_usermanual_hhp_qhelp_to_qhp
992	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
993	$$(out_dir)/qhelp/UserManual.qhp: \
994	$$(out_dir)/qhelp/UserManual.hhp \
995	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
996	\| $$$$(dir $$$$@)
997	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
998	$$(QUIET)$$(RM) -f $$@
999	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py -d $$(<D) -o $$@ -f UserManual.hhp -t UserManual.hhc
1000	endef
1001	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_qhelp_to_qhp))
1002
1003
1004	define def_ditamap_to_htmlhelp
1005	ditamap-to-htmlhelp: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp
1006	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp: \
1007	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
1008	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
1009	/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
1010	/transtype:htmlhelp \
1011	/ditadir:$(VBOX_DITA_PATH) \
1012	/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp \
1013	/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_htmlhelp
1014
1015	endef
1016	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_htmlhelp,$(lang)))
1017
1018	# copy the qhcp file.
1019	define def_vbox_cp_qhcp
1020	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
1021	$$(out_dir)/UserManual.qhcp: \
1022	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/% \| $$$$(dir $$$$@)
1023	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1024	endef
1025	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_qhcp)))
1026
1027	# copy the PNG files.
1028	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
1029	define def_vbox_cp_images_qhelp
1030	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
1031	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
1032	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
1033	$$(call MSG_L1,Copying temporary $$< => $$@)
1034	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1035	endef
1036	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_qhelp)))
1037
1038	endif # VBOX_WITH_DOCS_QHELP
1039
1040	# Handy aliases.
1041	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
1042	man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1043	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
1044
1045	#
1046	# Manually updating the DHCP option list taken from VirtualBox.xidl
1047	#
1048	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
1049	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
1050	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
1051
1052
1053	include $(FILE_KBUILD_SUB_FOOTER)
1054

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

Download in other formats:

Original Format