VirtualBox

source: vbox/trunk/doc/manual/Makefile.kmk@ 99008

Last change on this file since 99008 was 99008, checked in by vboxsync, 2 years ago

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

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette