Makefile.kmk@ 77312

Last change on this file since 77312 was 77312, checked in by vboxsync, 6 years ago
Makefile.kmk: fix incorrect expansion inside a define (yes, needs '$'x4), and add a few more directory creation dependencies just in case
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.9 KB

Line
1	# $Id: Makefile.kmk 77312 2019-02-14 14:58:44Z vboxsync $
2	## @file
3	# Sub-Makefile for the VirtualBox User Manual, SDK reference and other manuals.
4	#
5
6	#
7	# Copyright (C) 2006-2019 Oracle Corporation
8	#
9	# This file is part of VirtualBox Open Source Edition (OSE), as
10	# available from http://www.virtualbox.org. This file is free software;
11	# you can redistribute it and/or modify it under the terms of the GNU
12	# General Public License (GPL) as published by the Free Software
13	# Foundation, in version 2 as it comes in the "COPYING" file of the
14	# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	#
17
18	#
19	# This slightly messy makefile transforms the DocBook XML source for the
20	# user manual into presentation output. We support two targets:
21	#
22	# -- UserManual.pdf, generated by LaTex
23	#
24	# -- VirtualBox.chm
25	#
26	# Both files end up in PATH_STAGE_BIN.
27	#
28	# Both targets indirectly depend on the XML files in this directory;
29	# "indirectly" because we first copy them to PATH_TARGET and hack them
30	# up a bit for variable substitution and such (see below).
31	# The toolchains are roughly like this:
32	#
33	# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
34	# then create a .FO file (another XML format for "formatted objects")
35	# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
36	#
37	# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
38	# run our custom "dblatex" perl script on UserManual.xml, which parses
39	# the XML (using the Perl SAX parsers) and dumps a matching LaTeX file
40	# to UserManual.tex. This is then regularly processed by pdflatex to
41	# generate PDF.
42	#
43	# -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
44	# xsltproc to create a .HHP file for the Microsoft Help Compiler, then
45	# feed that file to it.
46	#
47
48	SUB_DEPTH = ../..
49	include $(KBUILD_PATH)/subheader.kmk
50
51	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
52	include $(PATH_SUB_CURRENT)/Config.kmk
53	endif
54
55
56	#
57	# Globals
58	#
59
60	# Error out if someone tries to override old globals.
61	ifdef HTMLHELPOPTS
62	$(error HTMLHELPOPTS was renamed to VBOX_HTMLHELP_OPTS!)
63	endif
64	ifdef DOCBOOKPATH
65	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
66	endif
67	ifdef DOCBOOKPATH
68	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
69	endif
70	ifdef XML_CATALOG
71	$(error XML_CATALOG was renamed to VBOX_XML_CATALOG!)
72	endif
73	ifdef XML_CATALOG_DOCBOOK
74	$(error XML_CATALOG_DOCBOOK was renamed to VBOX_XML_CATALOG_DOCBOOK!)
75	endif
76	ifdef VBOXMANAGEPATH
77	$(error VBOXMANAGEPATH was renamed to VBOXMANAGEHELP_PATH!)
78	endif
79	ifdef PDFLATEX_INTERACTION
80	$(error PDFLATEX_INTERACTION was renamed to VBOX_PDFLATEX_INTERACTION!)
81	endif
82	ifdef PDFLATEX
83	$(error PDFLATEX was renamed to VBOX_PDFLATEX_CMD!)
84	endif
85	ifdef HHC
86	$(error HHC was renamed to VBOX_HHC!)
87	endif
88
89
90
91	VBOXMANAGEHELP_PATH ?= $(PATH_STAGE_BIN)/VBoxManageHelp$(SUFF_EXE)
92
93	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
94	# without catting the log a million times.
95	VBOX_PDFLATEX_INTERACTION ?= batchmode
96	ifeq ($(KBUILD_HOST),win)
97	ifndef VBOX_PDFLATEX
98	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(PATH_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
99	ifneq ($(VBOX_PDFLATEX),)
100	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
101	endif
102	endif
103	ifndef VBOX_PDFLATEX
104	# Tell MiKTeX to automatically download packages if system wide install.
105	VBOX_PDFLATEX := pdflatex
106	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
107	endif
108	else
109	VBOX_PDFLATEX ?= pdflatex
110	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
111	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
112	endif
113
114	# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
115	VBOX_HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
116
117
118	# Additional xsltproc options when generating
119	VBOX_HTMLHELP_OPTS ?=
120
121	# SDK related globals.
122	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
123	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
124	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
125
126
127	#
128	# Targets
129	#
130
131	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
132
133
134	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
135	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
136	INSTALLS += VBox-docs-sdkref
137	endif
138
139	ifdef VBOX_WITH_DOCS_HTML
140	INSTALLS += VBox-docs-usermanual-html
141	VBOX_PATH_BIN_HTML = $(PATH_STAGE_BIN)/UserManual-html.zip
142	else # Do not build html.
143	VBOX_PATH_BIN_HTML =
144	endif
145
146	ifdef VBOX_WITH_DOCS_CHM
147	INSTALLS += VBox-docs-usermanual-chm
148	VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
149	else # Do not build chm.
150	VBOX_PATH_BIN_CHM =
151	endif
152
153	ifndef VBOX_ONLY_SDK
154	VBOX_MANUAL_PACK += \
155	$(PATH_STAGE_BIN)/UserManual.pdf \
156	$(VBOX_PATH_BIN_HTML) \
157	$(VBOX_PATH_BIN_CHM)
158	INSTALLS += VBox-docs-usermanual
159
160	ifdef VBOX_WITH_DOCS_TRANSLATIONS
161	INSTALLS += VBox-docs-usermanual-l10n
162	VBOX_MANUAL_PACK += \
163	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
164	ifdef VBOX_WITH_DOCS_CHM
165	INSTALLS += VBox-docs-usermanual-l10n-chm
166	VBOX_MANUAL_PACK += \
167	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
168	endif
169	endif
170	endif # !VBOX_ONLY_SDK
171
172	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
173	INSTALLS += VBox-docs-accessibility
174	INSTALLS += VBox-docs-accessibility-html
175	endif
176
177	ifdef VBOX_ONLY_DOCS
178	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
179	endif
180
181	ifdef VBOX_WITH_DOCS_TRANSLATIONS
182	VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
183	endif
184
185	VBOX_MANUAL_XML_FILES = \
186	UserManual.xml \
187	user_Preface.xml \
188	user_Introduction.xml \
189	user_Installation.xml \
190	user_BasicConcepts.xml \
191	user_GuestAdditions.xml \
192	user_Storage.xml \
193	user_Networking.xml \
194	user_Frontends.xml \
195	user_VBoxManage.xml \
196	user_AdvancedTopics.xml \
197	user_Technical.xml \
198	user_VirtualBoxAPI.xml \
199	user_Troubleshooting.xml \
200	user_Security.xml \
201	user_KnownIssues.xml \
202	user_ChangeLog.xml \
203	user_ThirdParty.xml \
204	user_PrivacyPolicy.xml \
205	user_Glossary.xml \
206	oracle-accessibility-en.xml \
207	oracle-support-en.xml
208
209	VBOX_MANUAL_XML_FILES_COMMON = \
210	$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml
211
212	$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
213	$(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \
214	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
215	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
216	$$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
217	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_isomakercmd-man.xml))
218
219	VBOX_SDKREF_XML_FILES = \
220	SDKRef.xml
221
222	VBOX_ACCESSIBILITY_XML_FILES = \
223	Accessibility.xml
224
225	# Wildcard the images path for every supported language
226	$(foreach f,$(VBOX_MANUAL_LANGUAGES), \
227	$(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
228
229	VBOX_MANUAL_TEX_UNICODE_FILES = \
230	$(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
231
232	VBOX_MANUAL_LATEX_FILES_TARGET = \
233	$(addprefix UserManual.,aux log out toc tex)
234
235	VBOX_SDKREF_LATEX_FILES_TARGET = \
236	$(addprefix SDKRef.,aux log out toc tex)
237
238	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
239	$(addprefix Accessibility.,aux log out toc tex)
240
241	BLDDIRS += \
242	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/,\
243	$(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
244	$(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
245	$(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
246	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
247	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
248	)
249
250	# Explicit cleaning has some overlap with default cleaning rules, since this
251	# Makefile is using very complex conditionals for selectively creating
252	# specific files, and not everyone remembers to use the same with "kmk clean".
253	OTHER_CLEAN += \
254	$(VBOX_XML_CATALOG) \
255	$(VBOX_XML_CATALOG_DOCBOOK) \
256	$(VBOX_XML_CATALOG_MANUAL) \
257	$(VBOX_XML_ENTITIES) \
258	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
259	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
260	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
261	isomakercmd-man.xml \
262	user_isomakercmd-man.xml \
263	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
264	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
265	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
266	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
267	html-single/UserManual.html \
268	$(addprefix HTMLHelp/, index.html go01.html) \
269	$(addprefix html-chunks/, index.html go01.html) \
270	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
271	,html-chunks/ch$(n).html \
272	html-chunks/re$(n).html \
273	HTMLHelp/ch$(n).html \
274	HTMLHelp/re$(n).html \
275	$(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)) ) \
276	$(foreach n,a b c \
277	,html-chunks/ap$(n).html \
278	HTMLHelp/ap$(n).html \
279	$(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) ) \
280	$(foreach n,01 02 03 04 05 \
281	,html-chunks/pr$(n).html \
282	HTMLHelp/pr$(n).html \
283	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) ) \
284	HTMLHelp/toc.hhc \
285	HTMLHelp/htmlhelp.hhp \
286	UserManual.pdf \
287	VirtualBox.chm \
288	ChangeLog.html \
289	validatemanual.run \
290	validateaccessibility.run \
291	validatesdkref.run \
292	)) \
293	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
294	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
295	$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
296	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
297	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
298	$(PATH_STAGE_BIN)/UserManual.pdf \
299	$(PATH_STAGE_BIN)/VirtualBox.chm \
300	\
301	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
302	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
303	SDKRef.pdf \
304	) \
305	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
306	\
307	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
308	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
309	html-single/Accessibility.html \
310	Accessibility.pdf \
311	) \
312	$(PATH_STAGE_BIN)/Accessibility.html \
313	$(PATH_STAGE_BIN)/Accessibility.pdf \
314	\
315	$(VBOX_DOC_XIDL_SRC_TMP) \
316	$(VBOX_MANUAL_APIREF_TMP)
317
318	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
319
320	#
321	# target for installing UserManual.pdf
322	#
323	VBox-docs-usermanual_INST = $(INST_BIN)
324	VBox-docs-usermanual_MODE = a+r,u+w
325	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
326
327	#
328	# target for installing translated UserManual_*.pdf
329	#
330	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
331	VBox-docs-usermanual-l10n_MODE = a+r,u+w
332	VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
333
334	#
335	# target for installing the chunked HTML docs
336	#
337	VBox-docs-usermanual-html_INST = $(INST_BIN)
338	VBox-docs-usermanual-html_MODE = a+r,u+w
339	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
340
341	#
342	# target for installing VirtualBox.chm
343	#
344	VBox-docs-usermanual-chm_INST = $(INST_BIN)
345	VBox-docs-usermanual-chm_MODE = a+r,u+w
346	VBox-docs-usermanual-chm_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
347
348	#
349	# target for installing translated VirtualBox_*.chm
350	#
351	VBox-docs-usermanual-l10n-chm_INST = $(INST_BIN)
352	VBox-docs-usermanual-l10n-chm_MODE = a+r,u+w
353	VBox-docs-usermanual-l10n-chm_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
354
355	#
356	# target for installing SDKRef.pdf
357	#
358	VBox-docs-sdkref_INST = $(INST_SDK)docs/
359	VBox-docs-sdkref_MODE = a+r,u+w
360	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
361
362	#
363	# target for installing Accessibility.pdf
364	#
365	VBox-docs-accessibility_INST = $(INST_BIN)
366	VBox-docs-accessibility_MODE = a+r,u+w
367	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
368
369	#
370	# target for installing Accessibility.html
371	#
372	VBox-docs-accessibility-html_INST = $(INST_BIN)
373	VBox-docs-accessibility-html_MODE = a+r,u+w
374	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
375
376
377
378	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
379
380	##
381	# Morph man pages into manual sections.
382	# $(evalcall2 def_vbox_refentry_to_user_sect1)
383	# @param 1 Language.
384	# @param 2 the refentry xml base file name.
385	# @param 3 the full refentry xml file path.
386	define def_vbox_refentry_to_user_sect1
387	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
388	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
389	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
390	$$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
391	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
392	$$(QUIET)$$(RM) -f "$$@"
393	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
394	endef
395	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
396	, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
397	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
398	,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
399
400
401	# Generates the VBoxManage command overview include file (shared between
402	# languages) from the refsynopsisdiv section of the man pages.
403	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
404	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
405	$$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
406	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
407	\| $$(dir $$@)
408	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
409	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
410
411	$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml: $(VBOXMANAGEHELP_PATH) $(MAKEFILE_CURRENT) \| $$(dir $$@)
412	$(call MSG_GENERATE,,$@,)
413	$(QUIET)$(RM) -f $@ [email protected]
414	$(QUIET)$(APPEND) -tn "$@" \
415	'<?xml version="1.0" encoding="UTF-8"?>' \
416	'<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">' \
417	'<sect1> <!-- this will be skipped via xpointer in the include. --> '
418	$(QUIET)$(REDIRECT) -wo [email protected] -E 'VBOX_LOG_FLAGS=disabled' -E 'VBOX_LOG_DEST=nofile' \
419	$(if $(eq $(KBUILD_TARGET),darwin), -E 'DYLD_FALLBACK_LIBRARY_PATH=$(dir $(LIB_RUNTIME))') \
420	-- \
421	$(VBOXMANAGEHELP_PATH) --dumpopts
422	$(QUIET)$(SED) \
423	-e ':a' \
424	-e 'N' \
425	-e '$(DOLLAR)!ba' \
426	-e 's/</\&lt\;/g' \
427	-e 's/>/\&gt\;/g' \
428	-e 's/\n*$(DOLLAR)/<\/screen>/' \
429	-e 's/^/<screen>/' \
430	--append $@ [email protected]
431	$(QUIET)$(RM) -f [email protected]
432	$(QUIET)$(APPEND) -n "$@" \
433	' <remark role="VBoxManage-overview">' \
434	$(foreach refentry, $(filter man_VBoxManage%,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
435	, ' <xi:include href="overview_$(refentry)" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />') \
436	' </remark>' \
437	'</sect1>'
438
439
440
441
442	##########################################################################################
443	#
444	# Shared rules for PDF generation
445	#
446	##########################################################################################
447
448	ifndef VBOX_OSE
449	# copy ucs.sty and related files
450	$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
451	$(call MSG_L1,Copying unicode support for LaTeX)
452	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
453	endif
454
455	# copy the PNG files.
456	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
457	define def_vbox_cp_images_pdf
458	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
459	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
460	$$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
461	$$(call MSG_L1,Copying temporary $$< => $$@)
462	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
463	endef
464	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
465
466
467	##########################################################################################
468	#
469	# UserManual.pdf
470	#
471	##########################################################################################
472
473
474	# Generate PDF from LaTeX
475	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
476	define def_vbox_usermanual_tex_to_pdf
477	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
478	$$(out_dir)/UserManual.pdf: \
479	$$(out_dir)/UserManual.tex \
480	$$(if $$(VBOX_OSE),,$$(out_dir)/ucs.sty) \
481	$$(addprefix $$(out_dir)/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \| $$$$(dir $$$$@)
482	# PDF generation via Latex: generate the .tex file
483	$$(call MSG_L1,pdflatex $$< (four passes) -> $$@)
484	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
485	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
486	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
487	$$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
488	$$(QUIET)$$(SED) -ne '/Warning: Hyper reference/p' $$(basename $$<).log
489	$$(QUIET)$$(SED) -n \
490	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
491	$$(basename $$@).log
492	$$(call MSG_L1,Fresh LaTeX-generated PDF is now at $$@)
493	endef
494	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_tex_to_pdf))
495
496	# Generate LaTeX from XML
497	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
498	define def_vbox_usermanual_xml_to_tex
499	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
500	$$(out_dir)/UserManual.tex: \
501	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
502	$$(VBOX_MANUAL_XML_FILES_COMMON) \
503	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
504	$$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
505	$$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
506	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
507	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
508	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(firstword $$(filter %.xml,$$^)),$$@)
509	$$(QUIET)$$(RM) -f $$(addprefix $$(@D)/,$$(VBOX_MANUAL_LATEX_FILES_TARGET))
510	# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
511	# pass current language to xsltproc in TARGETLANG variable
512	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(lang) \
513	-o [email protected] $$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $$<
514	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
515	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
516	$$(QUIET)$$(SED) \
517	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
518	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
519	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
520	--output $$@ [email protected]
521	$$(QUIET)$$(RM) -f [email protected]
522	endef
523	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_tex))
524
525	# Useful aliases
526	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
527
528	debug-usermanual:
529	$(MAKE) --pretty-command-printing -j1 VBOX_PDFLATEX_INTERACTION=errorstopmode $(PATH_STAGE_BIN)/UserManual.pdf
530
531	#
532	# Generate rules for validating the UserManual.xml. These are invoked
533	# automatically at build time, but can also be manually invoked via the
534	# 'validatemanual' and 'validatemanual_<lang>' aliases.
535	#
536	define def_vbox_validate_xml
537	validatemanual_$(lang):: $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run
538	$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run: \
539	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
540	$$(VBOX_MANUAL_XML_FILES_COMMON) \
541	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
542	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
543	$$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) \| $$$$(dir $$$$@)
544	$$(call MSG_L1,Validating $$<)
545	$$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
546	$$(QUIET)$$(APPEND) -t "$$@" "done"
547	endef
548	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_validate_xml))
549
550
551	# Handy aliases.
552	validatemanual:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),validatemanual_$(lang))
553
554
555
556	#
557	# SDKRef.pdf
558	#
559
560	# Replace <tt> tags in VirtualBox.xidl.
561	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
562	$(call MSG_L1,Generating $@)
563	$(QUIET)$(SED) -e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
564	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
565	--output $@ $<
566
567	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
568	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
569	$(call MSG_L1,Generating $@)
570	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
571
572	# Turn SDKRef.xml into LaTeX.
573	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
574	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
575	$(VBOX_MANUAL_APIREF_TMP) \
576	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
577	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
578	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
579	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
580	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
581	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
582	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
583	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
584	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
585	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
586	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
587	$(QUIET)$(SED) \
588	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
589	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
590	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
591	--output $@ [email protected]
592	$(QUIET)$(RM) -f [email protected]
593
594	# Turn SDKRef.tex into a PDF.
595	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
596	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
597	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
598	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
599	$(call MSG_L1,pdflatex $< (three passes))
600	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
601	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
602	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
603	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
604	$(QUIET)$(SED) -n \
605	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
606	$(basename $<).log
607	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
608
609	# Validating SDKRef.xml. It is invoked automatically at build time,
610	# but can also be manually invoked via the 'validate-sdkref' alias.
611	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
612	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
613	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
614	$(VBOX_MANUAL_APIREF_TMP) \
615	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
616	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
617	$(call MSG_L1,Validating $<)
618	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
619	$(QUIET)$(APPEND) -t "$@" "done"
620
621
622	# Handy aliases.
623	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
624	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
625
626
627
628	#
629	# Accessibility.pdf
630	#
631
632	# Turn Accessibility.xml into LaTeX.
633	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
634	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
635	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
636	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
637	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
638	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
639	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
640	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
641	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
642	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
643	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
644	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
645	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
646	$(QUIET)$(SED) \
647	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
648	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
649	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
650	--output $@ [email protected]
651	$(QUIET)$(RM) -f [email protected]
652
653	# Turn Accessibility.tex into a PDF.
654	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
655	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
656	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
657	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
658	$(call MSG_L1,pdflatex $< (three passes))
659	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
660	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
661	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
662	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
663	$(QUIET)$(SED) -n \
664	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
665	$(basename $<).log
666	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
667
668	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
669	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
670	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
671	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
672	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
673	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
674	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
675	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
676	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
677	$<
678
679	# Validating Accessibility.xml. It is invoked automatically at build time,
680	# but can also be manually invoked via the 'validate-accessibility' alias.
681	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
682	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
683	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
684	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
685	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
686	$(call MSG_L1,Validating $<)
687	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
688	$(QUIET)$(APPEND) -t "$@" "done"
689
690
691	# Handy aliases.
692	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
693	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
694	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
695
696
697
698	ifdef VBOX_WITH_DOCS_CHM
699	#
700	# VirtualBox.chm
701	#
702	# We first generate a .hhp help source file from the preprocessed
703	# DocBook XML files, as defined above, then feed that into the
704	# Microsoft Help Compiler.
705	#
706	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
707	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
708	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
709	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
710
711	# Prepare the XSL file for our title page, htmlhelp variant.
712	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
713	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
714	$(call MSG_L1,xsltproc $<)
715	$(QUIET)$(RM) -f [email protected] $@
716	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
717	$(QUIET)$(MV) -f [email protected] $@
718
719	# Generate CHM from HHP
720	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
721	define def_vbox_usermanual_hhp_to_chm
722	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
723	$$(out_dir)/VirtualBox.chm: \
724	$$(out_dir)/HTMLHelp/htmlhelp.hhp \
725	$$(addprefix $$(out_dir)/HTMLHelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
726	\| $$$$(dir $$$$@)
727	$$(call MSG_L1,hhc $$<,=> $$@)
728	$$(QUIET)$$(RM) -f $$@
729	$$(QUIET)$$(VBOX_HHC) $$(subst /,\\,$$<)
730	$$(call MSG_L1,Fresh CHM is now at $$@)
731	endef
732	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_to_chm))
733
734	# Generate HHP from XML
735	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
736	define def_vbox_usermanual_xml_to_hhp
737	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
738	$$(out_dir)/HTMLHelp/htmlhelp.hhp: \
739	$$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
740	$$(VBOX_MANUAL_XML_FILES_COMMON) \
741	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
742	$$(VBOX_DOCBOOK_HTMLHELP_FORMATCFG) \
743	$$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
744	$$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
745	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
746	$$(VBOX_XML_ENTITIES) \| $$$$(dir $$$$@)
747	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
748	$$(QUIET)$$(RM) -f $$@
749	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$(@D)/ \
750	--stringparam htmlhelp.chm \
751	$$(subst /,\\,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/VirtualBox.chm) \
752	$$(HTMLHELPOPTS) $$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
753	$$<
754	endef
755	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_hhp))
756
757	# copy the PNG files.
758	# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
759	define def_vbox_cp_images_htmlhelp
760	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
761	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
762	$$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
763	$$(call MSG_L1,Copying temporary $$< => $$@)
764	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
765	endef
766	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp)))
767
768	endif # VBOX_WITH_DOCS_CHM
769
770
771	# Packing the docs into a zip file
772	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
773	$(call MSG_L1,Packing documentation $@)
774	$(QUIET)$(RM) -f $@
775	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
776
777
778	##########################################################################################
779	#
780	# UserManual.html
781	#
782	##########################################################################################
783	VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
784	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
785	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
786	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
787
788	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
789	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
790	$(VBOX_MANUAL_XML_FILES_COMMON) \
791	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
792	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
793	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
794	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
795	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
796	$$(VBOX_XML_ENTITIES) \| $$(dir $$@)
797	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
798	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
799	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
800	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
801	$<
802
803	VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
804	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
805	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
806	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
807
808	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
809	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
810	$(VBOX_MANUAL_XML_FILES_COMMON) \
811	$(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
812	$(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
813	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
814	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
815	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
816	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
817	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
818	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
819	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
820	--stringparam chunk.section.depth 0 \
821	$(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
822	$<
823
824	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
825	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
826	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
827	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
828	$(call MSG_L1,Packing documentation $@)
829	$(QUIET)$(RM) -f $@
830	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
831	-9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
832
833	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
834	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
835	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
836
837
838	#
839	# ChangeLog.html
840	#
841	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
842	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
843	#
844	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
845	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
846	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
847	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
848	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
849	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
850	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
851	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
852
853	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
854
855
856
857	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
858
859
860	#
861	# VBoxManage man pages (parts also required by VBoxManage built-in help).
862	#
863
864	##
865	# Emits rules for preprocessing refentry sources (applying remarks element),
866	# and for producing the actual man pages.
867	# $(evalcall2 def_vbox_refentry_to_manpage)
868	# @param 1 The language
869	# @param 2 The file name (no path).
870	define def_vbox_refentry_to_manpage
871	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
872	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
873	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
874	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
875	$$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
876	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
877	$$(QUIET)$$(RM) -f "$$@"
878	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
879	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
880	if defined(VBOX_HAVE_XMLLINT)
881	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
882	endif
883
884	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
885	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
886	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
887	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
888	$$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
889	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
890	$$(QUIET)$$(RM) -f "$$@"
891	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
892	endef
893	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
894	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
895
896
897	# Handy aliases.
898	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
899	man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
900	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
901
902
903
904	include $(FILE_KBUILD_SUB_FOOTER)
905

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

Download in other formats:

Original Format