Makefile.kmk@ 105190

Last change on this file since 105190 was 105190, checked in by vboxsync, 10 months ago
Docs: bugref:10705. Dependency improvement (avoid forcing all builds to create the .kmk include files), plus scm fix.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 51.5 KB

Line
1	# $Id: Makefile.kmk 105190 2024-07-08 14:46:16Z 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 makefile produces our user manual (among a few other things) in
30	# 3 formats: qHelp, pdf, and html (chunked and single page). User manual
31	# files are kept in dita format. VBoxManage commands are documented using docbook
32	# refentry elements and integrated into VBoxManage binary after converting those
33	# to .cpp and .h files (not here). Additionally, we add these refentry's into the
34	# user manual as a chapter after converting them into dita files. Both the user manual
35	# and converted VBoxManage commands files are referenced with a single ditamap.
36	# This ditamap is then transformed into html, htmlhelp (for qHelp), and pdf.
37	#
38
39
40	SUB_DEPTH = ../..
41	include $(KBUILD_PATH)/subheader.kmk
42
43	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
44	include $(PATH_SUB_CURRENT)/Config.kmk
45	endif
46
47	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK)) # Whole file.
48
49	#
50	# Globals
51	#
52
53	## Combines the VBOX_MANUAL_LANGUAGES and VBOX_MANUAL_ADD_LANGUAGES lists from
54	# /Config.kmk, as per the VBOX_WITH_DOCS_TRANSLATIONS setting.
55	ifdef VBOX_WITH_DOCS_TRANSLATIONS
56	VBOX_MANUAL_ALL_LANGUAGES := $(VBOX_MANUAL_LANGUAGES) $(VBOX_MANUAL_ADD_LANGUAGES)
57	else
58	VBOX_MANUAL_ALL_LANGUAGES := $(VBOX_MANUAL_LANGUAGES)
59	endif
60
61	## The files that should go into VBoxDocumentation.zip (must be immediately under PATH_STAGE_BIN).
62	VBOX_MANUAL_PACK =
63
64	# Various file lists (mainly needed for OTHER_CLEAN).
65	VBOX_QHELP_OUTPUT_FILES := UserManual.qch UserManual.qhc
66	VBOX_ACCESSIBILITY_XML_FILES := Accessibility.xml
67	VBOX_MANUAL_LATEX_FILES_TARGET := $(addprefix UserManual.,aux log out toc tex)
68	VBOX_SDKREF_LATEX_FILES_TARGET := $(addprefix SDKRef.,aux log out toc tex)
69	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET := $(addprefix Accessibility.,aux log out toc tex)
70
71	VBOX_MANUAL_TEX_UNICODE_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
72
73	# Wildcard the images path for every supported language
74	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
75	,$(eval VBOX_MANUAL_PNG_FILES_$$(lang) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(lang)/%,%, \
76	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(lang)/images/*.png))))
77
78	# SDK related globals.
79	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
80	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
81	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
82
83
84	#
85	# PDF LaTeX related globals.
86	#
87
88	VBOX_PDFLATEX_INTERACTION ?= batchmode
89	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
90	# without catting the log a million times.
91	ifeq ($(KBUILD_HOST),win)
92	ifndef VBOX_PDFLATEX
93	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
94	ifneq ($(VBOX_PDFLATEX),)
95	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
96	endif
97	endif
98	ifndef VBOX_PDFLATEX
99	# Tell MiKTeX to automatically download packages if system wide install.
100	VBOX_PDFLATEX := pdflatex
101	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
102	endif
103	else
104	VBOX_PDFLATEX ?= pdflatex
105	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
106	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
107	endif
108
109	#
110	# Java v17 or later (JAVA_HOME), used by DITA-OT.
111	#
112	ifeq ($(VBOX_JAVA17PLUS_HOME),)
113	if defined(VBOX_JAVA_VERSION) && $(VBOX_JAVA_VERSION) >= 170000 && "$(VBOX_JAVA_BIN_PATH)" != ""
114	VBOX_JAVA17PLUS_HOME := $(qabspath ,$(VBOX_JAVA_BIN_PATH)/..)
115	else
116	VBOX_JAVA17PLUS_HOME := $(firstfile \
117	$(rversortfiles $(qwildcard , $(KBUILD_DEVTOOLS_HST)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST)/jdk/v[2-9][0-9].* )) \
118	$(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS_HST_ALT)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST_ALT)/jdk/v[2-9][0-9].* )) \
119	)
120	if "$(KBUILD_HOST)" == "darwin" && "$(VBOX_JAVA17PLUS_HOME)" != ""
121	VBOX_JAVA17PLUS_HOME := $(VBOX_JAVA17PLUS_HOME)/Contents/Home
122	endif
123	endif
124	endif
125
126	#
127	# DITA-OT related globals.
128	#
129	VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH = $(VBOX_DITA_OT_PATH)/plugins/org.oasis-open.dita.v1_2/dtd/technicalContent/dtd
130
131	##
132	# Runs the dost.jar.
133	#
134	# @param 1 Additional kmk_redirect options.
135	# @param 2 Parameters for the invoker.
136	#
137	VBOX_DITA_RUN_DOST = $(REDIRECT_EXT) \
138	-E 'ANT_HOME=$(VBOX_DITA_OT_PATH)' \
139	-E 'DITA_DIR=$(VBOX_DITA_OT_PATH)' \
140	-E 'JAVA_HOME=$(VBOX_JAVA17PLUS_HOME)' \
141	-E 'CLASSPATH=$(VBOX_DITA_CLASSPATH)' \
142	$1 \
143	-- \
144	"$(VBOX_JAVA17PLUS_HOME)/bin/java" \
145	"-Djava.awt.headless=true" \
146	"-Dsun.io.useCanonCaches=true" \
147	"-Dant.home=$(VBOX_DITA_OT_PATH)" \
148	"-Ddita.dir=$(VBOX_DITA_OT_PATH)" \
149	org.apache.tools.ant.launch.Launcher \
150	-cp "$(VBOX_DITA_CLASSPATH)" \
151	-buildfile "$(VBOX_DITA_OT_PATH)/build.xml" \
152	-main "org.dita.dost.invoker.Main" \
153	--args.grammar.cache=yes \
154	--verbose \
155	$(if-expr defined(VBOX_DITA_DEBUG),"--clean.temp=no" "--debug",) \
156	$2
157
158	VBOX_DITA_CLASSPATH = \
159	$(subst $(SP),$(HOST_PATH_SEP),$(strip \
160	$(VBOX_DITA_OT_PATH)/lib/ant-launcher.jar \
161	$(VBOX_DITA_OT_PATH)/config \
162	$(VBOX_DITA_OT_PATH)/lib \
163	$(wildcard \
164	$(VBOX_DITA_OT_PATH)/lib/*.jar \
165	$(VBOX_DITA_OT_PATH)/plugins//lib/.jar)))
166
167
168	#
169	# Targets
170	#
171
172	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_ALL_LANGUAGES))
173
174	ifdef VBOX_ONLY_DOCS
175	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
176	endif
177
178	BLDDIRS += \
179	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita \
180	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics \
181	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
182
183	BLDDIRS += \
184	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
185	$(addsuffix /images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
186	$(addsuffix /html-single, $(VBOX_MANUAL_ALL_LANGUAGES)) \
187	$(addsuffix /html-chunks, $(VBOX_MANUAL_ALL_LANGUAGES)) \
188	$(addsuffix /qhelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
189	$(addsuffix /qhelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
190	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
191	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
192	)
193
194	# Explicit cleaning has some overlap with default cleaning rules, since this
195	# Makefile is using very complex conditionals for selectively creating
196	# specific files, and not everyone remembers to use the same with "kmk clean".
197	OTHER_CLEAN += \
198	$(VBOX_XML_CATALOG) \
199	$(VBOX_XML_CATALOG_DOCBOOK) \
200	$(VBOX_XML_CATALOG_MANUAL) \
201	$(VBOX_XML_ENTITIES) \
202	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES) \
203	,$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
204	$(VBOX_XML_XREF_TO_TEXT) \
205	$(VBOX_XML_XREF_TO_TEXT).cat \
206	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
207	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
208	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
209	man_VBoxHeadless.xml \
210	user_man_VBoxHeadless.xml \
211	man_vboximg-mount.xml \
212	user_man_vboximg-mount.xml \
213	isomakercmd-man.xml \
214	user_isomakercmd-man.xml \
215	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
216	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
217	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
218	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
219	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
220	html-single/UserManual.html \
221	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
222	$(addprefix HTMLHelp/, index.html go01.html) \
223	$(addprefix qhelp/, index.html go01.html) \
224	$(addprefix html-chunks/, index.html go01.html) \
225	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
226	,html-chunks/ch$(n).html \
227	html-chunks/re$(n).html \
228	HTMLHelp/ch$(n).html \
229	HTMLHelp/re$(n).html \
230	$(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)) \
231	qhelp/ch$(n).html \
232	qhelp/re$(n).html \
233	$(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)) ) \
234	$(foreach n,a b c \
235	,html-chunks/ap$(n).html \
236	HTMLHelp/ap$(n).html \
237	$(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) \
238	qhelp/ap$(n).html \
239	$(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) ) \
240	$(foreach n,01 02 03 04 05 \
241	,html-chunks/pr$(n).html \
242	HTMLHelp/pr$(n).html \
243	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
244	qhelp/pr$(n).html \
245	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
246	HTMLHelp/toc.hhc \
247	HTMLHelp/htmlhelp.hhp \
248	qhelp/toc.hhc \
249	qhelp/htmlhelp.hhp \
250	UserManual.pdf \
251	$(VBOX_QHELP_OUTPUT_FILES) \
252	ChangeLog.html \
253	validatemanual.run \
254	validateaccessibility.run \
255	validatesdkref.run \
256	) \
257	) \
258	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
259	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
260	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
261	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US) \
262	$(addsuffix .kmk,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)) \
263	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US) \
264	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip \
265	$(PATH_STAGE_BIN)/RefEntryDITA.zip \
266	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip \
267	$(PATH_STAGE_BIN)/UserManual-html.zip \
268	$(PATH_STAGE_BIN)/UserManual.pdf \
269	$(PATH_STAGE_BIN)/VBoxDocumentation.zip \
270	\
271	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
272	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
273	SDKRef.pdf \
274	) \
275	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
276	\
277	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
278	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
279	html-single/Accessibility.html \
280	Accessibility.pdf \
281	) \
282	$(PATH_STAGE_BIN)/Accessibility.html \
283	$(PATH_STAGE_BIN)/Accessibility.pdf \
284	\
285	$(VBOX_DOC_XIDL_SRC_TMP) \
286	$(VBOX_MANUAL_APIREF_TMP)
287
288
289	ifndef VBOX_ONLY_SDK
290	#
291	# target for installing UserManual.pdf
292	#
293	INSTALLS += VBox-docs-usermanual
294	VBox-docs-usermanual_INST = $(INST_BIN)
295	VBox-docs-usermanual_MODE = a+r,u+w
296	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
297	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual.pdf
298
299	ifdef VBOX_WITH_DOCS_TRANSLATIONS
300	#
301	# target for installing translated UserManual_*.pdf
302	#
303	INSTALLS += VBox-docs-usermanual-l10n
304	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
305	VBox-docs-usermanual-l10n_MODE = a+r,u+w
306	VBox-docs-usermanual-l10n_SOURCES = \
307	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
308	VBOX_MANUAL_PACK += $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
309	endif
310
311	ifdef VBOX_WITH_DOCS_HTML
312	#
313	# target for installing the chunked HTML docs
314	#
315	INSTALLS += VBox-docs-usermanual-html
316	VBox-docs-usermanual-html_INST = $(INST_BIN)
317	VBox-docs-usermanual-html_MODE = a+r,u+w
318	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
319	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual-html.zip
320	endif
321
322	ifdef VBOX_WITH_DOCS_QHELP
323	#
324	# Installs the qhelp version of the manual.
325	#
326	INSTALLS += VBox-docs-usermanual-qhelp
327	VBox-docs-usermanual-qhelp_INST = $(INST_BIN)
328	VBox-docs-usermanual-qhelp_MODE = a+r,u+w
329	VBox-docs-usermanual-qhelp_SOURCES = \
330	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc \
331	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
332	ifdef VBOX_WITH_DOCS_QHELP_PACKING
333	VBOX_MANUAL_PACK += \
334	$(PATH_STAGE_BIN)/UserManual.qch \
335	$(PATH_STAGE_BIN)/UserManual.qhc
336	endif
337	endif
338
339	ifdef VBOX_WITH_DOCS_USERMANUAL_REFENTRY_DITA
340	#
341	# target for installing the chunked HTML docs
342	#
343	INSTALLS += VBox-docs-usermanual-refentry-dita
344	VBox-docs-usermanual-refentry-dita_INST = $(INST_BIN)
345	VBox-docs-usermanual-refentry-dita_MODE = a+r,u+w
346	VBox-docs-usermanual-refentry-dita_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
347	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/RefEntryDITA.zip
348	endif
349
350	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
351	#
352	# target for installing Accessibility.pdf
353	#
354	INSTALLS += VBox-docs-accessibility
355	VBox-docs-accessibility_INST = $(INST_BIN)
356	VBox-docs-accessibility_MODE = a+r,u+w
357	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
358
359	#
360	# target for installing Accessibility.html
361	#
362	INSTALLS += VBox-docs-accessibility-html
363	VBox-docs-accessibility-html_INST = $(INST_BIN)
364	VBox-docs-accessibility-html_MODE = a+r,u+w
365	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
366	endif
367
368	endif # !VBOX_ONLY_SDK
369
370	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
371	#
372	# target for installing SDKRef.pdf
373	#
374	INSTALLS += VBox-docs-sdkref
375	VBox-docs-sdkref_INST = $(INST_SDK)docs/
376	VBox-docs-sdkref_MODE = a+r,u+w
377	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
378	endif
379
380
381	#
382	# Shared rules for LaTeX based PDF generation - Only used for SDK & Accessibility.
383	#
384
385	ifndef VBOX_OSE
386	# Copy ucs.sty and associated files.
387	## @todo r=bird: This is ugly since only ucs.sty is listed as output while we're actually copying 177 other files.
388	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/ucs.sty): \| $$(dir $$@)
389	$(call MSG_L1,Copying unicode support for LaTeX)
390	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
391	endif
392
393	# Copy the PNG files.
394	define def_vbox_cp_images_pdf
395	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
396	$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/% : \
397	$(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
398	$$(call MSG_L1,Copying temporary $$< => $$@)
399	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
400	endef
401	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
402
403
404	#################################################################################################################################
405	# SDKRef.pdf - xidl => Docbook => LaTeX => PDF #
406	#################################################################################################################################
407
408	VBOX_SDKREF_XML_FILES = SDKRef.xml
409
410	# Replace @a and @c with <tt> tags in VirtualBox.xidl.
411	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
412	$(call MSG_L1,Generating $@)
413	$(QUIET)$(SED) \
414	-e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
415	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
416	--output $@ $<
417
418	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
419	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
420	$(call MSG_L1,Generating $@)
421	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
422
423	# Turn SDKRef.xml into LaTeX.
424	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
425	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
426	$(VBOX_MANUAL_APIREF_TMP) \
427	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
428	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
429	$(VBOX_XML_CATALOG) \
430	$(VBOX_XML_CATALOG_DOCBOOK) \
431	$(VBOX_XML_CATALOG_MANUAL) \
432	$(VBOX_XML_ENTITIES) \
433	$(MAKEFILE_CURRENT) \
434	\| $$(dir $$@)
435	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
436	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
437	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
438	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
439	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
440	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
441	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
442	$(QUIET)$(SED) \
443	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
444	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
445	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
446	--output $@ $@.tmp
447	$(QUIET)$(RM) -f $@.tmp
448
449	# Turn SDKRef.tex into a PDF.
450	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
451	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
452	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
453	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
454	\| $$(dir $$@)
455	$(call MSG_L1,pdflatex $< (three passes))
456	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
457	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
458	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
459	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
460	$(QUIET)$(SED) -n \
461	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
462	$(basename $<).log
463	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
464
465	# Validating SDKRef.xml. It is invoked automatically at build time,
466	# but can also be manually invoked via the 'validate-sdkref' alias.
467	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
468	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
469	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
470	$(VBOX_MANUAL_APIREF_TMP) \
471	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
472	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
473	$(call MSG_L1,Validating $<)
474	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
475	$(QUIET)$(APPEND) -t "$@" "done"
476
477
478	# Handy aliases.
479	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
480	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
481
482
483	#################################################################################################################################
484	# Accessibility.pdf - Docbook => LaTeX => PDF #
485	#################################################################################################################################
486
487	# Turn Accessibility.xml into LaTeX.
488	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
489	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
490	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
491	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
492	$(VBOX_XML_CATALOG) \
493	$(VBOX_XML_CATALOG_DOCBOOK) \
494	$(VBOX_XML_CATALOG_MANUAL) \
495	$(VBOX_XML_ENTITIES) \
496	$(MAKEFILE_CURRENT) \
497	\| $$(dir $$@)
498	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
499	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
500	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
501	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
502	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
503	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
504	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
505	$(QUIET)$(SED) \
506	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
507	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
508	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
509	--output $@ $@.tmp
510	$(QUIET)$(RM) -f $@.tmp
511
512	# Turn Accessibility.tex into a PDF.
513	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
514	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
515	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
516	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
517	$(call MSG_L1,pdflatex $< (three passes))
518	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
519	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
520	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
521	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
522	$(QUIET)$(SED) -n \
523	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
524	$(basename $<).log
525	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
526
527	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
528	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
529	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
530	$(VBOX_XML_CATALOG) \
531	$(VBOX_XML_CATALOG_DOCBOOK) \
532	$(VBOX_XML_CATALOG_MANUAL) \
533	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
534	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
535	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
536	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
537	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
538	$<
539
540	# Validating Accessibility.xml. It is invoked automatically at build time,
541	# but can also be manually invoked via the 'validate-accessibility' alias.
542	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
543	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
544	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
545	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
546	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
547	$(call MSG_L1,Validating $<)
548	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
549	$(QUIET)$(APPEND) -t "$@" "done"
550
551
552	# Handy aliases.
553	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
554	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
555	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
556
557
558	#################################################################################################################################
559	# UserManual.* - The user manual in all its output variations (DITA-OT). #
560	#################################################################################################################################
561
562	#
563	# 1. We copy/hardlink all the files under <lang>/dita/* to the corresponding
564	# VBOX_PATH_MANUAL_OUTBASE location. This is mainly to deal with DITO-OT's
565	# inability to search for topic files in more than one place, so we have to
566	# gather generated and static topic sources + the .ditamap-file(s) in one
567	# place.
568	#
569
570	# Determine the basic set of files as dictated by the en_US version of the
571	# user manual (relative to $(lang)/dita). We'll use these to supply
572	# incomplete manual translations.
573	# Note! This includes .png as well as .dita and .ditamap files.
574	VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES := \
575	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/.dita)) \
576	$(addprefix topics/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita))) \
577	$(addprefix topics/images/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*png)))
578
579	##
580	# Produce copying rules for one language and defining the variable
581	# VBOX_USER_MANUAL_DITA_STAGED_FILES_<lang> for use in prerequisite to
582	# anything producing a version of the user manual.
583	#
584	# @param 1 lang
585	define def_vbox_copy_manual_dita_src_files
586	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1) := \
587	$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/*.ditamap)) \
588	$$(addprefix topics/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/*dita))) \
589	$$(addprefix topics/images/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/images/*png)))
590	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK := \
591	$$(filter-out $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)), $$(VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES))
592
593	VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1) = \
594	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/, \
595	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
596	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) )
597
598	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)),)
599	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1))): \
600	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
601	$$(VBOX_PATH_MANUAL_SRC)/$1/dita/% \| $$$$(dir $$$$@)
602	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
603	endif
604
605	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK),)
606	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK)): \
607	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
608	$$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% \| $$$$(dir $$$$@)
609	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
610	endif
611
612	endef
613	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_copy_manual_dita_src_files,$(lang)))
614
615
616	#
617	# 2. Convert the manpages from Docbook refentry files to DITA reference files.
618	#
619	# In DITA links needs proper href values, with both file and ID. Since the
620	# source only has IDs, we scan all topics and refentry-files alike and
621	# generate a mapping database before we start converting them. This DB is
622	# then used at the end of each conversion to fix the hrefs.
623	#
624
625	##
626	# Do per-language stuff for the refentry -> dita file conversion.
627	#
628	# The variable VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_<lang> is defined
629	# by this define and should be expanded as a prerequisite for any rule
630	# producing a version of the user manual.
631	#
632	# @param 1 Language.
633	#
634	define def_vbox_refentry_to_dita
635	# Generate a ID to FILE mapping database that def_vbox_refentry_to_dita can apply below.
636	VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1) := $$(VBOX_PATH_MANUAL_OUTBASE)/$1/id-mapping-file.db
637	OTHER_CLEAN += $(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1))
638	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)) + $$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)).lst: \
639	$$(VBOX_PATH_MANUAL_SRC)/build_id_to_file_mapping.py \
640	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/*.xml) \
641	$$(filter %.dita,$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1))) \
642	\| $$$$(dir $$$$@)
643	$$(call MSG_L1, $$<)
644	$$(QUIET)$$(APPEND) -nt "$$@.lst" $$(filter-out %.py,$$^)
645	$$(QUIET)$$(VBOX_BLD_PYTHON) "$$<" --output "$$@" @"$$@.lst"
646
647	# Accumulated list of conversion output file names to be used as a
648	# prerequisite in rules producing a version of the user manual.
649	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 :=
650
651	endef # def_vbox_refentry_to_dita
652
653	## Convert a single refentry file to dita.
654	# @param 1 Language
655	# @param 2 Filename w/o extension.
656	# @param 3 Alternative fallback filename (for isomakercmd-man.xml).
657	# @note This produces more files than listed in the output, but we currently let kmk be ignorant of that.
658	define def_vbox_refentry_file_to_dita
659	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap
660	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap \
661	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap.kmk \
662	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita \
663	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml: \
664	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
665	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
666	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.sh \
667	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl \
668	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-topic-ids.xsl \
669	$$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
670	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1) \
671	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
672	$$(VBOX_XML_CATALOG) \
673	$$(VBOX_XML_CATALOG_DOCBOOK) \
674	$$(VBOX_XML_CATALOG_MANUAL) \
675	$$(VBOX_XML_ENTITIES) \
676	$$(VBOX_VERSION_STAMP) \
677	\| $$$$(dir $$$$@)
678	$$(call MSG_TOOL,xsltproc docbook-refentry-to-manual-dita[-pre].xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
679	$$(QUIET)$$(RM) -f -- "$$@" \
680	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml" \
681	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
682	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
683	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml" \
684	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
685	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml)
686	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
687	--stringparam "g_fReplaceHyphens" "true" \
688	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita" \
689	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
690	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml"
691	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
692	--mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1)" \
693	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
694	$$(QUIET)$$(ASH) \
695	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.sh" \
696	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita" \
697	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-topic-ids.xsl" \
698	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl" \
699	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap.kmk" \
700	"VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_$(1)" \
701	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics" \
702	-- $$(subst $$(REDIRECT),$$(REDIRECT_EXT),$$(call VBOX_XSLTPROC_WITH_CAT)) $(VBOX_XSLTPROC_WORKAROUND) \
703	--path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)"
704	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) $(VBOX_XSLTPROC_WORKAROUND) \
705	--path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)" \
706	--stringparam g_sMode map \
707	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap" \
708	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl \
709	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
710
711	endef # def_vbox_refentry_file_to_dita
712
713	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
714	,$(evalcall2 def_vbox_refentry_to_dita,$(lang)) \
715	$(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount man_VBoxHeadless) \
716	,$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),$(file))) \
717	$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),user_isomakercmd-man, \
718	$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
719
720	ifdef VBOX_ONLY_DOCS
721	include $(VBOX_PATH_MANUAL_OUTBASE)/refentry.kmk
722
723	$(VBOX_PATH_MANUAL_OUTBASE)/refentry.kmk: \
724	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
725	,$(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(lang).kmk)
726	$(QUIET)$(RM) -f -- "$@"
727	$(APPEND) -tn "$@" '# refentry.kmk'
728	$(APPEND) -n "$@" $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),'include $(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(lang).kmk')
729	$(APPEND) -n "$@" '# done'
730
731	## Include file for all language specific refentry files.
732	# @param 1 Language
733	define def_vbox_refentry_lang_kmk
734	$$(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(1).kmk: \
735	$$(addsuffix .kmk,$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1)))
736	$$(QUIET)$$(RM) -f -- "$$@"
737	$$(APPEND) -tn "$$@" '# refentry_$(1).kmk'
738	$$(APPEND) -n "$$@" $$(addprefix 'include ,$$(addsuffix .kmk',$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1))))
739	$$(APPEND) -n "$$@" '# done'
740
741	endef # def_vbox_refentry_lang_kmk
742
743	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
744	,$(evalcall2 def_vbox_refentry_lang_kmk,$(lang)))
745	endif
746
747	# Run conversion testcase.
748	refentry-to-dita-test:
749	$(RM) -f -- \
750	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml" \
751	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.dita"
752	$(call VBOX_XSLTPROC_WITH_CAT) \
753	--output "$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml" \
754	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
755	$(VBOX_PATH_MANUAL_SRC)/testcase/refentry1.xml
756	$(call VBOX_XSLTPROC_WITH_CAT) \
757	--output "$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.dita" \
758	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
759	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml"
760
761	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip: \
762	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
763	$(call MSG_L1,Packing documentation $@)
764	$(QUIET)$(RM) -f $@
765	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
766	-9 -r "$@" \
767	$(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)) \
768	$(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US))
769
770	refentry-dita-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
771
772	#
773	# 2b. Generate the VBoxManage commands overview topic based upon the
774	# command synopis dita files generated in the above step.
775	#
776
777	# @param 1 Language
778	define def_vbox_generate_vboxmanage_overview
779	VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita
780	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita \
781	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita.files.xml: \
782	$$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
783	$$(VBOX_PATH_MANUAL_SRC)/vboxmanage-cmd-overview.xsl \
784	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1)) \
785	\| $$$$(dir $$$$@)
786	$$(call MSG_TOOL,xsltproc vboxmanage-cmd-overview.dita.xsl,,,$$@)
787	$$(QUIET)$$(RM) -f -- "$$@" "$$@.files.xml"
788	$$(APPEND) -tn "$$@.files.xml" '<?xml version="1.0"?>' '<files>'
789	$$(SED) -n \
790	-e 's/^.topicref .topics\/man_VBoxManage-$[^.]$\.ditamap.$$(DOLLAR)/<file>vboxmanage-\1-synopsis.dita<\/file>/p' \
791	--append "$$@.files.xml" \
792	$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/UserManual.ditamap
793	$$(APPEND) -n "$$@.files.xml" '</files>'
794	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) $(VBOX_XSLTPROC_WORKAROUND) --path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)" \
795	--output "$$@" \
796	$$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
797	"$$@.files.xml"
798
799	endef # def_vbox_generate_vboxmanage_overview
800	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_generate_vboxmanage_overview,$(lang)))
801
802
803	#
804	# 3. Convert the changelog from DocBook to a bunch of DITA topics and corresponding map.
805	#
806
807	##
808	# @param 1 Language
809	# @note We don't really need to do this for each language, but whatever.
810	# @note Outputs a bunch of .dita files for each version too...
811	define def_vbox_convert_changelog_to_dita
812	VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap
813	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap: \
814	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
815	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
816	$$(VBOX_XML_CATALOG) \
817	$$(VBOX_XML_CATALOG_DOCBOOK) \
818	$$(VBOX_XML_CATALOG_MANUAL) \
819	\| $$$$(dir $$$$@)
820	$$(call MSG_TOOL,xsltproc docbook-changelog-to-manual-dita.xsl,,,$$@)
821	$$(QUIET)$$(RM) -f -- "$$@" "$$@.files.xml"
822	$$(QUIET)$$(ASH) \
823	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
824	$$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml \
825	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
826	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics \
827	-- \
828	$$(call VBOX_XSLTPROC_WITH_CAT)
829	endef # def_vbox_convert_changelog_to_dita
830	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_convert_changelog_to_dita,$(lang)))
831
832
833	#
834	# 4a. UserManual.pdf - Run dost.jar from DITA-OT to produce the PDF version.
835	#
836	# Note! The --temp (dir) is deleted, recreated, used and deleted again for each
837	# run. So, be careful where you point it.
838	# Note! This crappy utility may fail to find files (or fail to parse the
839	# command line) and still return a successfully (0) exit code.
840	#
841	define def_ditamap_to_pdf
842	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf \
843	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log \
844	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.list \
845	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.xml.properties: \
846	$$(VBOX_MANUAL_XML_FILES_COMMON) \
847	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
848	$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(lang)) \
849	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(lang)) \
850	$$(VBOX_PATH_MANUAL_SRC)/pdf-theme-UserManual.yaml \
851	$$(VBOX_PATH_MANUAL_SRC)/en_US/images/vboxlogo.png
852	$$(call MSG_L1,Building $$@ ($$(@D)/UserManual_pdf.log))
853	$$(QUIET)$$(RM) -f -- "$$@"
854	$$(QUIET)$$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf"
855	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,, \
856	"--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
857	"--format=pdf" \
858	"--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
859	"--output=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
860	"--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf" \
861	"--theme=$$(VBOX_PATH_MANUAL_SRC)/pdf-theme-UserManual.yaml" \
862	"--logfile=$$(@D)/UserManual_pdf.log" \
863	)
864
865	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
866	.PRECIOUS: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log
867	endef
868	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
869
870	# Useful aliases
871	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
872
873
874	#
875	# 4b. UserManual.html - Run dost.jar from DITA-OT to produce the HTML versions.
876	#
877	# We produce both chunked and singled paged HTML versions of the en_US manual
878	# mainly for uploading to virtualbox.org. The docs build box produces a zip
879	# including these.
880	#
881
882	## @todo front page
883	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
884	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
885	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
886	$(QUIET)$(RM) -Rf -- "$(@D)" \
887	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks"
888	$(call MSG_L1,Building html chunks $@ ($(@D)/UserManual_xhtml.log))
889	$(QUIET)$(MKDIR) -- "$(@D)"
890	$(QUIET)$(call VBOX_DITA_RUN_DOST,, \
891	"--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
892	"--format=xhtml" \
893	"--filter=$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
894	"--output=$(@D)" \
895	"--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \
896	"--logfile=$(@D)/UserManual_xhtml.log" \
897	"--store-type=memory" \
898	)
899
900	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
901
902	# We must modify UserManual.ditamap here, removing all chunk attributes and put
903	# a chunk="to-content" on the root element (bookmap). For clues see:
904	# https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
905	# https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
906	# We stich the index.html and UserManual-Single.html files together using
907	# SED since we haven't been able to convince DITA-OT to combine them.
908	#
909	## @todo This is excruciatingly slow with 4.0.2 because of a preprocessing step
910	# (move-meta in the org.dita.base plugin) is doing 986 read+writes of
911	# the singled combined dita document (XML). This is probably the two
912	# for loops in the pushMetadata() method in
913	# src/main/java/org/dita/dost/module/MoveMetaModule.java. The netbeans
914	# profiler says that ouf 283 sec runtime, 64 secs are spent reading
915	# the xml big doc and 212 secs spent writing it out again (212+64=276).
916	#
917	# For the chunked version, the move-meta work is done on each .ditamap
918	# and .dita (topic) file instead, which is a lot less expensive.
919	#
920	# The problem is forced by the AbstractDomFilter.read() design, which
921	# reads XML to DOM, modifies DOM, writes out DOM as XML. The
922	# modifications done by the DitaMetaWriter.process function is
923	# restricted to a single topic, which is means this must be done this
924	# way.
925	#
926	# A workaround, though, would be to implement a custom cache that
927	# cache the document and doesn't write it to disk until the loops
928	# finishes. This could build on the CacheStore.java code, only
929	# potential challenge is to clone the job as the Job.store property is
930	# immutable.
931	#
932	## @todo front page
933	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
934	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
935	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
936	$(call MSG_L1,Building html chunks $@ ($(@D)/UserManual-Single_xhtml.log))
937	$(QUIET)$(RM) -Rf -- "$(@D)" \
938	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single/" \
939	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap"
940	$(SED) -r -e 's/ chunk=["][^"]+["]//g' -e 's/<bookmap /<bookmap chunk="to-content" /' \
941	--output "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
942	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap"
943	$(QUIET)$(MKDIR) -- "$(@D)"
944	$(QUIET)$(call VBOX_DITA_RUN_DOST,, \
945	"--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
946	"--format=xhtml" \
947	"--output=$(@D)" \
948	"--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_single" \
949	"--logfile=$(@D)/UserManual-Single_xhtml.log" \
950	"--store-type=memory" \
951	)
952	$(SED) -ne '1,/<body>/{p}' \
953	--output "$@" "$(@D)/UserManual-Single.html"
954	$(APPEND) -n "$@" "<!-- index inject: -->"
955	$(SED) -ne '/<body>/,/<\/body>/{/<body>/d;/<\/body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
956	--append "$@" "$(@D)/index.html"
957	$(APPEND) -n "$@" "<!-- resuming main file: -->"
958	$(SED) -ne '/<body>/,99999999{/<body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
959	--append "$@" "$(@D)/UserManual-Single.html"
960
961	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
962
963	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
964	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
965	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
966	$(call MSG_L1,Packing documentation $@)
967	$(QUIET)$(RM) -f $@
968	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
969	-9 -r "$@" \
970	"html-chunks" \
971	"html-single" \
972	-x "html-chunks/dita.list" \
973	-x "html-chunks/dita.xml.properties" \
974	-x "html-chunks/UserManual_xhtml.log" \
975	-x "html-single/dita.list" \
976	-x "html-single/dita.xml.properties" \
977	-x "html-single/UserManual-Single_xhtml.log" \
978	-x "html-single/index.html" \
979	-x "html-single/UserManual-Single.html"
980
981	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
982
983
984	#
985	# A few things which are shared between htmlhelp and qhelp docs.
986	# TODO: This is Docbook related work. Left here in case we can reuse some of
987	# the ideas from it for DITA-OT.
988	#
989
990	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
991	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
992	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
993	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
994
995	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
996	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
997	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
998	$(call MSG_L1,xsltproc $<)
999	$(QUIET)$(RM) -f $@.tmp $@
1000	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o $@.tmp $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
1001	$(QUIET)$(MV) -f $@.tmp $@
1002
1003	# end old stuff.
1004
1005	if defined(VBOX_WITH_DOCS_QHELP) && !defined(VBOX_ONLY_SDK)
1006	#
1007	# 4c. VirtualBox.qch + VirtualBox.qhc - Qt compressed help and collection file.
1008	#
1009	# See usermanual.pdf under DITA-OT-xxxxx/doc folder for details.
1010	#
1011
1012	# Enable Qt and locate the Qt help generator.
1013	USES += qt6
1014	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
1015
1016	## Build QHelp version of manual for given language.
1017	# @param 1 Language
1018	# @param 2 The language specific qhelp output directory.
1019	define def_vbox_usermanual_as_qhelp
1020
1021	# 1. Generate UserManual.hpp using DITA-OT.
1022	#
1023	# Setting HHCDIR here so that it fails to locate hcc.exe and always skips the
1024	# compilation step that produces the .chm-file, since we don't need it and it
1025	# mangles the path so it always fails anyway.
1026	#
1027	# HACK ALERT! Putting MSG_L1 between RM and MKDIR as the latter sometimes fails
1028	# on windows because the deleted directory still exists on Windows.
1029	#
1030	# HACK ALERT! For 4.0.2 we must set Ant property dita.output.dir to the output
1031	# dir to prevent the .hhp+.html+*.png files from being placed in
1032	# the temporary directory and removed upon completion (idea being
1033	# that hhc.exe had run and the files weren't needed any more - the
1034	# htmlhelp plugin sets temp.output.dir.name to 'temp_chm_dir').
1035	#
1036	## @todo front page.
1037	$(2)/UserManual.hhp: \
1038	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1)) \
1039	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1))
1040	$$(QUIET)$$(RM) -Rf -- "$$(@D)" \
1041	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp"
1042	$$(call MSG_L1,dita-ot-qhelp, => $$@ ($(2)/UserManual_htmlhelp.log))
1043	$$(QUIET)$$(MKDIR) -- "$$(@D)"
1044	$$(QUIET)$$(call VBOX_DITA_RUN_DOST, -EHHCDIR="$$(@D)", \
1045	"--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
1046	"--format=htmlhelp" \
1047	"--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
1048	"--output=$(2)" \
1049	"--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp" \
1050	"--logfile=$(2)/UserManual_htmlhelp.log" \
1051	"-Ddita.output.dir=$(2)" \
1052	)
1053
1054	ditamap-to-htmlhelp: $(2)/UserManual.hhp
1055
1056	# 2. Generate a Qt Help Project file (QHP) using htmlhelp-qthelp.py.
1057	$(2)/UserManual.qhp: \
1058	$(2)/UserManual.hhp \
1059	$$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py
1060	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
1061	$$(QUIET)$$(RM) -f -- "$$@"
1062	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py \
1063	-d "$$(<D)" -o "$$@" -f UserManual.hhp -t UserManual.hhc
1064
1065	# 3. Copy the Qt help configuration file from source to the output dir.
1066	$(2)/UserManual.qhcp: \
1067	$$(VBOX_PATH_MANUAL_SRC)/UserManual.qhcp \
1068	$(2)/UserManual.hhp # Order-only gets confused by rm -Rf, as kmk will cache the existance of the target \
1069	# file and not remake it because kmk thinks it still exists. Real dep fixes this.
1070	$$(call MSG_L1,, => $$@ ($(2)/UserManual_htmlhelp.log))
1071	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1072
1073	# 4. Run the Qt help generator to produce the .qhc and .qch files.
1074	$(2)/UserManual.qch \
1075	+ $(2)/UserManual.qhc: \
1076	$(2)/UserManual.qhcp \
1077	$(2)/UserManual.qhp
1078	$$(call MSG_L1,$$(notdir $$(VBOX_QHELPGENERATOR)) $$<,=> $$@)
1079	$$(QUIET)$$(RM) -f -- "$$@"
1080	$$(QUIET)$$(REDIRECT) -E "QT_PLUGIN_PATH=$$(PATH_SDK_QT6)/plugins" -E "QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT6)/plugins/platforms" -- $$(VBOX_QHELPGENERATOR) $$<
1081	$$(call MSG_L1,Fresh QCH is now at $$@)
1082
1083	endef # def_vbox_usermanual_as_qhelp
1084
1085	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
1086	,$(evalcall2 def_vbox_usermanual_as_qhelp,$(lang),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp))
1087
1088	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
1089
1090	endif # VBOX_WITH_DOCS_QHELP && !VBOX_ONLY_SDK
1091
1092
1093	#################################################################################################################################
1094	# Miscellaneous #
1095	#################################################################################################################################
1096
1097	#
1098	# ChangeLog.html
1099	#
1100	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
1101	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
1102	#
1103	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
1104	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
1105	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
1106	$(VBOX_XML_CATALOG) \
1107	$(VBOX_XML_CATALOG_DOCBOOK) \
1108	$(VBOX_XML_CATALOG_MANUAL) \
1109	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
1110	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
1111	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
1112	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
1113
1114	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
1115
1116
1117	#
1118	# VBoxManage man pages (parts also required by VBoxManage built-in help).
1119	#
1120
1121	##
1122	# Emits rules for preprocessing refentry sources (applying remarks element),
1123	# and for producing the actual man pages.
1124	# $(evalcall2 def_vbox_refentry_to_manpage)
1125	# @param 1 The language
1126	# @param 2 The file name (no path).
1127	define def_vbox_refentry_to_manpage
1128	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
1129	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
1130	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
1131	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
1132	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
1133	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
1134	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
1135	$$(QUIET)$$(RM) -f "$$@"
1136	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
1137	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
1138	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@.tmp $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
1139	$$(QUIET)$$(MV) -f -- "$$@.tmp" "$$@"
1140	if defined(VBOX_HAVE_XMLLINT)
1141	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
1142	endif
1143
1144	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
1145	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
1146	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
1147	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
1148	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
1149	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
1150	$$(QUIET)$$(RM) -f "$$@"
1151	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
1152	endef
1153	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1154	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
1155
1156	# Handy aliases.
1157	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
1158	man-experiment:: $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1159	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
1160
1161	#
1162	# Manually updating the DHCP option list taken from VirtualBox.xidl
1163	#
1164	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
1165	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
1166	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $^
1167
1168
1169	#
1170	# Packing the docs into a zip file (part of the packing pass on the docs build box).
1171	#
1172	ifneq ($(VBOX_MANUAL_PACK),)
1173	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
1174	$(call MSG_L1,Packing documentation $@)
1175	$(QUIET)$(RM) -f $@
1176	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
1177	endif
1178
1179
1180	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
1181
1182	include $(FILE_KBUILD_SUB_FOOTER)
1183

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

Download in other formats:

Original Format