Makefile.kmk@ 99056

Last change on this file since 99056 was 99056, checked in by vboxsync, 2 years ago
manual/Makefile.kmk: Cleaning up the makefile step by step... bugref:10348 bugref:10302
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 40.4 KB

Line
1	# $Id: Makefile.kmk 99056 2023-03-19 21:58:09Z 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	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK)) # Whole file.
62
63	#
64	# Globals
65	#
66
67	## The files that should go into VBoxDocumentation.zip (must be immediately under PATH_STAGE_BIN).
68	VBOX_MANUAL_PACK =
69
70	ifndef VBOX_ONLY_SDK
71	ifdef VBOX_WITH_DOCS_QHELP
72	ifdef VBOX_WITH_QT6
73	USES += qt6
74	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
75	else
76	USES += qt5
77	VBOX_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')
78	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT5_BIN)/$(if-expr $(VBOX_QHELPGENERATOR_VERSION_MINOR) >= 12,qhelpgenerator,qcollectiongenerator)
79	endif
80	endif
81
82	endif # ! VBOX_ONLY_SDK
83
84	VBOX_QHELP_OUTPUT_FILES := UserManual.qch UserManual.qhc
85
86	# SDK related globals.
87	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
88	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
89	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
90
91	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
92	# without catting the log a million times.
93	VBOX_PDFLATEX_INTERACTION ?= batchmode
94	ifeq ($(KBUILD_HOST),win)
95	ifndef VBOX_PDFLATEX
96	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
97	ifneq ($(VBOX_PDFLATEX),)
98	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
99	endif
100	endif
101	ifndef VBOX_PDFLATEX
102	# Tell MiKTeX to automatically download packages if system wide install.
103	VBOX_PDFLATEX := pdflatex
104	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
105	endif
106	else
107	VBOX_PDFLATEX ?= pdflatex
108	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
109	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
110	endif
111
112	##
113	# Copies DITA-OT to $1, runs the dost.jar with /ditadir given and nukes $1 when done.
114	#
115	# Additional options for dost.jar can be specified following the call to VBOX_DITA_RUN_DOST
116	#
117	# @param 1 Temporary+unique DITA-OT path.
118	# @param 2 Additional kmk_redirect options.
119	#
120	VBOX_DITA_RUN_DOST ?= $(REDIRECT) \
121	-E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
122	-E 'ANT_HOME=$1/tools/ant' \
123	-E 'DITA_DIR=$1' \
124	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
125	-A 'PATH=$(HOST_PATH_SEP)$1/tools/ant/bin' \
126	-E 'CLASSPATH=$1/lib/dost.jar' \
127	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib' \
128	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/commons-codec-1.4.jar' \
129	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/resolver.jar' \
130	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/icu4j.jar' \
131	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xercesImpl.jar' \
132	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xml-apis.jar' \
133	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9.jar' \
134	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9-dom.jar' \
135	$2 \
136	-- $(ASH) $(VBOX_PATH_MANUAL_SRC)/dita-ot-copy-exec.sh "$(VBOX_DITA_ORIGINAL_PATH)" "$1" \
137	-- $(VBOX_JAVA) -jar "$1/lib/dost.jar" "/ditadir:$1" # "/outercontrol:fail" ?
138
139
140	#
141	# Targets
142	#
143
144	## @todo r=bird:Why outside the big if statement? There should be no targets if not entered...
145	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
146
147
148	ifdef VBOX_ONLY_DOCS
149	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
150	endif
151
152	## @todo r=bird: why here? We already used it VBOX_MANUAL_LANGUAGES, and BLDDIRS not being a
153	## simple variable this will modify the result after it's been used, which is confusing.
154	ifdef VBOX_WITH_DOCS_TRANSLATIONS
155	VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
156	endif
157
158	$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
159	$(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \
160	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
161	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
162	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_VBoxHeadless.xml \
163	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_vboximg-mount.xml \
164	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_isomakercmd-man.xml))
165
166	VBOX_SDKREF_XML_FILES = \
167	SDKRef.xml
168
169	VBOX_ACCESSIBILITY_XML_FILES = \
170	Accessibility.xml
171
172
173	# Wildcard the images path for every supported language
174	$(foreach f,$(VBOX_MANUAL_LANGUAGES), \
175	$(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
176
177	VBOX_MANUAL_TEX_UNICODE_FILES = \
178	$(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
179
180	VBOX_MANUAL_LATEX_FILES_TARGET = \
181	$(addprefix UserManual.,aux log out toc tex)
182
183	VBOX_SDKREF_LATEX_FILES_TARGET = \
184	$(addprefix SDKRef.,aux log out toc tex)
185
186	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
187	$(addprefix Accessibility.,aux log out toc tex)
188
189	BLDDIRS += \
190	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita \
191	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics \
192	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
193
194	BLDDIRS += \
195	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
196	$(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
197	$(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
198	$(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
199	$(addsuffix /qhelp, $(VBOX_MANUAL_LANGUAGES)) \
200	$(addsuffix /qhelp/images, $(VBOX_MANUAL_LANGUAGES)) \
201	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
202	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
203	)
204
205	# Explicit cleaning has some overlap with default cleaning rules, since this
206	# Makefile is using very complex conditionals for selectively creating
207	# specific files, and not everyone remembers to use the same with "kmk clean".
208	OTHER_CLEAN += \
209	$(VBOX_XML_CATALOG) \
210	$(VBOX_XML_CATALOG_DOCBOOK) \
211	$(VBOX_XML_CATALOG_MANUAL) \
212	$(VBOX_XML_ENTITIES) \
213	$(foreach lang, $(VBOX_MANUAL_LANGUAGES) \
214	,$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
215	$(VBOX_XML_XREF_TO_TEXT) \
216	$(VBOX_XML_XREF_TO_TEXT).cat \
217	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
218	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
219	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
220	man_VBoxHeadless.xml \
221	user_man_VBoxHeadless.xml \
222	man_vboximg-mount.xml \
223	user_man_vboximg-mount.xml \
224	isomakercmd-man.xml \
225	user_isomakercmd-man.xml \
226	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
227	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
228	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
229	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
230	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
231	html-single/UserManual.html \
232	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
233	$(addprefix HTMLHelp/, index.html go01.html) \
234	$(addprefix qhelp/, index.html go01.html) \
235	$(addprefix html-chunks/, index.html go01.html) \
236	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
237	,html-chunks/ch$(n).html \
238	html-chunks/re$(n).html \
239	HTMLHelp/ch$(n).html \
240	HTMLHelp/re$(n).html \
241	$(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)) \
242	qhelp/ch$(n).html \
243	qhelp/re$(n).html \
244	$(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)) ) \
245	$(foreach n,a b c \
246	,html-chunks/ap$(n).html \
247	HTMLHelp/ap$(n).html \
248	$(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) \
249	qhelp/ap$(n).html \
250	$(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) ) \
251	$(foreach n,01 02 03 04 05 \
252	,html-chunks/pr$(n).html \
253	HTMLHelp/pr$(n).html \
254	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
255	qhelp/pr$(n).html \
256	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
257	HTMLHelp/toc.hhc \
258	HTMLHelp/htmlhelp.hhp \
259	qhelp/toc.hhc \
260	qhelp/htmlhelp.hhp \
261	UserManual.pdf \
262	VirtualBox.chm \
263	$(VBOX_QHELP_OUTPUT_FILES) \
264	ChangeLog.html \
265	validatemanual.run \
266	validateaccessibility.run \
267	validatesdkref.run \
268	) \
269	) \
270	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
271	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
272	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
273	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
274	$(PATH_STAGE_BIN)/UserManual.pdf \
275	$(PATH_STAGE_BIN)/VirtualBox.chm \
276	\
277	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
278	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
279	SDKRef.pdf \
280	) \
281	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
282	\
283	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
284	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
285	html-single/Accessibility.html \
286	Accessibility.pdf \
287	) \
288	$(PATH_STAGE_BIN)/Accessibility.html \
289	$(PATH_STAGE_BIN)/Accessibility.pdf \
290	\
291	$(VBOX_DOC_XIDL_SRC_TMP) \
292	$(VBOX_MANUAL_APIREF_TMP)
293
294
295	ifndef VBOX_ONLY_SDK
296	#
297	# target for installing UserManual.pdf
298	#
299	INSTALLS += VBox-docs-usermanual
300	VBox-docs-usermanual_INST = $(INST_BIN)
301	VBox-docs-usermanual_MODE = a+r,u+w
302	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
303	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual.pdf
304
305	ifdef VBOX_WITH_DOCS_TRANSLATIONS
306	#
307	# target for installing translated UserManual_*.pdf
308	#
309	INSTALLS += VBox-docs-usermanual-l10n
310	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
311	VBox-docs-usermanual-l10n_MODE = a+r,u+w
312	VBox-docs-usermanual-l10n_SOURCES = \
313	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
314	VBOX_MANUAL_PACK += $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
315	endif
316
317	ifdef VBOX_WITH_DOCS_QHELP
318	#
319	# Installs the qhelp version of the manual.
320	#
321	INSTALLS += VBox-docs-usermanual-qhelp
322	VBox-docs-usermanual-qhelp_INST = $(INST_BIN)
323	VBox-docs-usermanual-qhelp_MODE = a+r,u+w
324	VBox-docs-usermanual-qhelp_SOURCES = \
325	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc \
326	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
327	ifdef VBOX_WITH_DOCS_QHELP_PACKING
328	VBOX_MANUAL_PACK += \
329	$(PATH_STAGE_BIN)/UserManual.qch \
330	$(PATH_STAGE_BIN)/UserManual.qhc
331	endif
332	endif
333
334	ifdef VBOX_WITH_DOCS_HTML
335	#
336	# target for installing the chunked HTML docs
337	#
338	INSTALLS += VBox-docs-usermanual-html
339	VBox-docs-usermanual-html_INST = $(INST_BIN)
340	VBox-docs-usermanual-html_MODE = a+r,u+w
341	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
342	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual-html.zip
343	endif
344
345	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
346	#
347	# target for installing Accessibility.pdf
348	#
349	INSTALLS += VBox-docs-accessibility
350	VBox-docs-accessibility_INST = $(INST_BIN)
351	VBox-docs-accessibility_MODE = a+r,u+w
352	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
353
354	#
355	# target for installing Accessibility.html
356	#
357	INSTALLS += VBox-docs-accessibility-html
358	VBox-docs-accessibility-html_INST = $(INST_BIN)
359	VBox-docs-accessibility-html_MODE = a+r,u+w
360	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
361	endif
362
363	endif # !VBOX_ONLY_SDK
364
365	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
366	#
367	# target for installing SDKRef.pdf
368	#
369	INSTALLS += VBox-docs-sdkref
370	VBox-docs-sdkref_INST = $(INST_SDK)docs/
371	VBox-docs-sdkref_MODE = a+r,u+w
372	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
373	endif
374
375
376	##
377	# Morph man pages into manual sections.
378	# $(evalcall2 def_vbox_refentry_to_user_sect1)
379	# @param 1 Language.
380	# @param 2 the refentry xml base file name.
381	# @param 3 the full refentry xml file path.
382	define def_vbox_refentry_to_user_sect1
383	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
384	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
385	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
386	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
387	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
388	$$(QUIET)$$(RM) -f "$$@"
389	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
390	endef
391	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
392	man_VBoxHeadless.xml \
393	man_vboximg-mount.xml \
394	, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
395	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
396	,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
397
398
399	# Generates the VBoxManage command overview include file (shared between
400	# languages) from the refsynopsisdiv section of the man pages.
401	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
402	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
403	$$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
404	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
405	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
406	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
407	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
408
409
410
411
412
413	##########################################################################################
414	#
415	# Shared rules for PDF generation
416	#
417	##########################################################################################
418
419	ifndef VBOX_OSE
420	# copy ucs.sty and related files
421	$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
422	$(call MSG_L1,Copying unicode support for LaTeX)
423	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
424	endif
425
426	# copy the PNG files.
427	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
428	define def_vbox_cp_images_pdf
429	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
430	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
431	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
432	$$(call MSG_L1,Copying temporary $$< => $$@)
433	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
434	endef
435	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
436
437
438	#
439	# SDKRef.pdf
440	#
441
442	# Replace <tt> tags in VirtualBox.xidl.
443	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
444	$(call MSG_L1,Generating $@)
445	$(QUIET)$(SED) -e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
446	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
447	--output $@ $<
448
449	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
450	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
451	$(call MSG_L1,Generating $@)
452	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
453
454	# Turn SDKRef.xml into LaTeX.
455	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
456	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
457	$(VBOX_MANUAL_APIREF_TMP) \
458	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
459	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
460	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
461	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
462	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
463	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
464	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
465	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
466	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
467	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
468	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
469	$(QUIET)$(SED) \
470	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
471	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
472	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
473	--output $@ [email protected]
474	$(QUIET)$(RM) -f [email protected]
475
476	# Turn SDKRef.tex into a PDF.
477	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
478	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
479	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
480	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
481	$(call MSG_L1,pdflatex $< (three passes))
482	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
483	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
484	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
485	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
486	$(QUIET)$(SED) -n \
487	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
488	$(basename $<).log
489	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
490
491	# Validating SDKRef.xml. It is invoked automatically at build time,
492	# but can also be manually invoked via the 'validate-sdkref' alias.
493	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
494	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
495	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
496	$(VBOX_MANUAL_APIREF_TMP) \
497	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
498	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
499	$(call MSG_L1,Validating $<)
500	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
501	$(QUIET)$(APPEND) -t "$@" "done"
502
503
504	# Handy aliases.
505	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
506	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
507
508
509
510	#
511	# Accessibility.pdf
512	#
513
514	# Turn Accessibility.xml into LaTeX.
515	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
516	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
517	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
518	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
519	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
520	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
521	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
522	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
523	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
524	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
525	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
526	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
527	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
528	$(QUIET)$(SED) \
529	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
530	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
531	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
532	--output $@ [email protected]
533	$(QUIET)$(RM) -f [email protected]
534
535	# Turn Accessibility.tex into a PDF.
536	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
537	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
538	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
539	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
540	$(call MSG_L1,pdflatex $< (three passes))
541	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
542	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
543	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
544	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
545	$(QUIET)$(SED) -n \
546	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
547	$(basename $<).log
548	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
549
550	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
551	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
552	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
553	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
554	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
555	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
556	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
557	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
558	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
559	$<
560
561	# Validating Accessibility.xml. It is invoked automatically at build time,
562	# but can also be manually invoked via the 'validate-accessibility' alias.
563	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
564	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
565	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
566	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
567	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
568	$(call MSG_L1,Validating $<)
569	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
570	$(QUIET)$(APPEND) -t "$@" "done"
571
572
573	# Handy aliases.
574	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
575	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
576	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
577
578
579	# A few things which are shared between htmlhelp and qhelp docs.
580	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
581	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
582	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
583	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
584
585	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
586	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
587	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
588	$(call MSG_L1,xsltproc $<)
589	$(QUIET)$(RM) -f [email protected] $@
590	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
591	$(QUIET)$(MV) -f [email protected] $@
592
593	# Packing the docs into a zip file
594	ifneq ($(VBOX_MANUAL_PACK),)
595	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
596	$(call MSG_L1,Packing documentation $@)
597	$(QUIET)$(RM) -f $@
598	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
599	endif
600
601
602	##########################################################################################
603	#
604	# DITA stuff common to pdf, qhelp, and html outputs.
605	# - copy DITA-OT library (binaries etc) since at each run several run-time config
606	# files are updated.
607	# - create dita/topic folder and copy all user manual dita files under that.
608	# - copy all images under dita/topics/images and UserManual.ditamap under dita folder
609	# - copy all man_V*.xml docbook files under dita/topic folder.
610	# - flatten refsect1/refsect2 hierarchy in man_V*.xml docbook files by
611	# using refsect2_to_refsect1.py.
612	# - convert man_V*.xml files into dita files
613	# - mark external link in the man_V*.dita files
614	# - correct all reference targets by calling correct_references.py.
615	#
616	# Note! INSTALL_STAGING is likely to hardlink the files, thus we must use +\| below
617	# when copying files as much won't change timestamp. It would in fact be a _lot_
618	# better to copy the files individually.
619	#
620	##########################################################################################
621
622	VBOX_USER_MANUAL_STAGED_DITA_FILES := $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/, \
623	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)))
624	VBOX_USER_MANUAL_STAGED_IMAGE_FILES := $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images/, \
625	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)))
626
627	$(VBOX_USER_MANUAL_STAGED_DITA_FILES) \
628	$(VBOX_USER_MANUAL_STAGED_IMAGE_FILES) \
629	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap: \
630	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/% : \
631	$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% \| $$(dir $$@)
632	$(QUIET)$(INSTALL_STAGING) -m 0644 -- "$<" "$(@D)/"
633
634	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/reference.dtd: \| $$(dir $$@)
635	$(QUIET)$(TOUCH) -- "$@"
636
637	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml: \
638	$(VBOX_PATH_MANUAL_SRC)/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml \| $$(dir $$@)
639	$(QUIET)$(INSTALL_STAGING) -m 0644 -- "$<" "$(@D)/"
640
641	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common: \
642	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
643	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/reference.dtd \
644	$(VBOX_USER_MANUAL_STAGED_DITA_FILES) \
645	$(VBOX_USER_MANUAL_STAGED_IMAGE_FILES) \
646	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES)
647	$(call MSG_L1, Ran common dita steps)
648	$(QUIET)$(TOUCH) -- "$@"
649
650
651	##########################################################################################
652	#
653	# Docbook to Dita conversion of our refentry files
654	#
655	##########################################################################################
656
657	# Generate a ID to FILE mapping database that def_vbox_refentry_to_dita can apply below.
658	VBOX_USER_MANUAL_ID_MAPPING_FILE := $(VBOX_PATH_MANUAL_OUTBASE)/en_US/id-mapping-file.db
659	OTHER_CLEAN += $(VBOX_USER_MANUAL_ID_MAPPING_FILE)
660	$(VBOX_USER_MANUAL_ID_MAPPING_FILE): \
661	$(VBOX_PATH_MANUAL_SRC)/build_id_to_file_mapping.py \
662	$(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/.xml $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/.dita) \
663	\| $(dir $@)
664	$(call MSG_L1, $<)
665	$(QUIET)$(VBOX_BLD_PYTHON) "$<" --output "$@" \
666	"$(VBOX_PATH_MANUAL_SRC)/en_US/*.xml" \
667	"$(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*.dita"
668
669	# Accumulated list of conversion output file names used by dita_common above.
670	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES := $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita
671
672	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita: \
673	$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
674	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml \| $$(dir $$@)
675	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
676	--maxdepth 6000 \
677	--output "$@" \
678	"$<" \
679	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml
680
681	define def_vbox_refentry_to_dita
682	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(basename $(2)).dita
683	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(basename $(2)).dita \
684	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2): \
685	$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
686	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2)) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2)) \
687	$$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl \
688	$$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
689	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE) \
690	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml \
691	$$(VBOX_XML_CATALOG) \
692	$$(VBOX_XML_CATALOG_DOCBOOK) \
693	$$(VBOX_XML_CATALOG_MANUAL) \
694	$$(VBOX_XML_ENTITIES) \
695	$$(VBOX_VERSION_STAMP) \
696	\| $$$$(dir $$$$@)
697	$$(call MSG_TOOL,xsltproc docbook2dita.xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
698	$$(QUIET)$$(RM) -f "$$@"
699	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/refsect2_to_refsect1.py \
700	-i $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2)) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2)) \
701	-o "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)"
702	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
703	"$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl" \
704	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)"
705	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
706	"$$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl" "$$@"
707	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
708	--mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE)" "$$@"
709	endef
710	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
711	,$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount.xml man_VBoxHeadless.xml \
712	,$(evalcall2 def_vbox_refentry_to_dita,$(lang),$(file))))
713
714
715	##########################################################################################
716	#
717	# UserManual.html
718	#
719	##########################################################################################
720
721	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
722	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
723	$(call MSG_L1,Packing documentation $@)
724	$(QUIET)$(RM) -f $@
725	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
726	-9 -r $@ html-chunks
727
728	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
729	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
730	$(call MSG_L1,Building html chunks $@)
731	$(QUIET)$(RM) -Rf -- "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks/"
732	$(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks) \
733	"/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
734	"/transtype:xhtml" \
735	"/outdir:$(@D)" \
736	"/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml"
737
738	# disable for now
739	## bird: Remove @chunk attrib from Glossary.dita topicref and add chunk="to-content" to bootmap for single html experiments.
740	## See https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
741	## and https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
742	## for further clues.
743	#html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
744
745	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
746	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
747	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
748
749
750	##########################################################################################
751	#
752	# Use DITA-OT to create pdf/hhp out of UserManual.ditamap. See usermanual.pdf under
753	# DITA-OT-xxxxx/doc folder for details.
754	#
755	##########################################################################################
756
757
758	# Note! The /tempdir is deleted, recreated, used and deleted again for each run. So, be careful where you point it.
759	# Note! This crappy utility may fail to find files (or fail to parse the
760	# command line) and still return a successfully (0) exit code.
761	define def_ditamap_to_pdf
762	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf \
763	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log \
764	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.list \
765	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.xml.properties: \
766	$$(VBOX_MANUAL_XML_FILES_COMMON) \
767	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
768	$$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
769	$$(QUIET)$(RM) -f -- "$$@"
770	$$(QUIET)$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf/"
771	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf) \
772	"/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
773	"/transtype:pdf" \
774	"/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
775	"/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf"
776
777	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
778	endef
779	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
780
781	# Useful aliases
782	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
783
784	#
785	# ChangeLog.html
786	#
787	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
788	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
789	#
790	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
791	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
792	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
793	$(VBOX_XML_CATALOG) \
794	$(VBOX_XML_CATALOG_DOCBOOK) \
795	$(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) --output "$@" "$<" $(filter %.xml,$^)
799	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
800
801	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
802
803
804
805	#
806	# VBoxManage man pages (parts also required by VBoxManage built-in help).
807	#
808
809	##
810	# Emits rules for preprocessing refentry sources (applying remarks element),
811	# and for producing the actual man pages.
812	# $(evalcall2 def_vbox_refentry_to_manpage)
813	# @param 1 The language
814	# @param 2 The file name (no path).
815	define def_vbox_refentry_to_manpage
816	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
817	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
818	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
819	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
820	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
821	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
822	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
823	$$(QUIET)$$(RM) -f "$$@"
824	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
825	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
826	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
827	$$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
828	if defined(VBOX_HAVE_XMLLINT)
829	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
830	endif
831
832	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
833	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
834	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
835	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
836	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
837	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
838	$$(QUIET)$$(RM) -f "$$@"
839	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
840	endef
841	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
842	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
843
844	ifdef VBOX_WITH_DOCS_QHELP
845	#
846	# VirtualBox.qch/VirtualBox.qhc
847	#
848	# We first generate a .hhp help source file from the preprocessed
849	# DocBook XML files, as defined above, then feed that into a converter
850	# creating the suitable input for creating a QHelp collection file.
851
852	# Generate QCH from QHelp source
853	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
854	define def_vbox_usermanual_qhp_to_qch
855	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
856	$$(out_dir)/qhelp/UserManual.qch \
857	+ $$(out_dir)/qhelp/UserManual.qhc: \
858	$$(out_dir)/qhelp/UserManual.qhcp \
859	$$(out_dir)/qhelp/UserManual.qhp \
860	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
861	\| $$$$(dir $$$$@)
862	$$(call MSG_L1,$$(notdir $$(VBOX_QHELPGENERATOR)) $$<,=> $$@)
863	$$(QUIET)$$(RM) -f $$@
864	$$(QUIET)$$(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT5)/plugins -- $$(VBOX_QHELPGENERATOR) $$<
865	$$(call MSG_L1,Fresh QCH is now at $$@)
866	endef
867	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_qhp_to_qch))
868
869	# Generate QHP from HHP for QHelp
870	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
871	define def_vbox_usermanual_hhp_qhelp_to_qhp
872	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
873	$$(out_dir)/qhelp/UserManual.qhp: \
874	$$(out_dir)/qhelp/UserManual.hhp \
875	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
876	\| $$$$(dir $$$$@)
877	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
878	$$(QUIET)$$(RM) -f $$@
879	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py -d $$(<D) -o $$@ -f UserManual.hhp -t UserManual.hhc
880	endef
881	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_qhelp_to_qhp))
882
883
884	# Setting HHCDIR here so that it fails to locate hcc.exe and always skips the
885	# compilation step that produces the .chm-file, since we don't need it and it
886	# mangles the path so it always fails anyway.
887	define def_ditamap_to_htmlhelp
888	ditamap-to-htmlhelp: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp
889	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp: \
890	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
891	$$(QUIET)$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-qhelp/"
892	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-qhelp, -EHHCDIR="$$(@D)") \
893	"/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
894	"/transtype:htmlhelp" \
895	"/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp" \
896	"/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_htmlhelp"
897
898	endef
899	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_htmlhelp,$(lang)))
900
901	# copy the qhcp file.
902	define def_vbox_cp_qhcp
903	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
904	$$(out_dir)/UserManual.qhcp: \
905	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/% \| $$$$(dir $$$$@)
906	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
907	endef
908	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_qhcp)))
909
910	# copy the PNG files.
911	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
912	define def_vbox_cp_images_qhelp
913	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
914	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
915	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
916	$$(call MSG_L1,Copying temporary $$< => $$@)
917	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
918	endef
919	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_qhelp)))
920
921	endif # VBOX_WITH_DOCS_QHELP
922
923	# Handy aliases.
924	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
925	man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
926	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
927
928	#
929	# Manually updating the DHCP option list taken from VirtualBox.xidl
930	#
931	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
932	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
933	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
934
935
936	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
937
938	include $(FILE_KBUILD_SUB_FOOTER)
939

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

Download in other formats:

Original Format