Config.kmk@ 99569

Last change on this file since 99569 was 99501, checked in by vboxsync, 20 months ago
manual: Generate VBoxManage command overview topic from converted synopsis dita-files. [build fix] bugref:10302
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 25.1 KB

Line
1	# $Id: Config.kmk 99501 2023-04-21 09:46:47Z vboxsync $
2	## @file
3	# kBuild Configuration file for the manual.
4	#
5
6	#
7	# Copyright (C) 2010-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	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
29	VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED = 1
30
31	# Include the top-level configure file.
32	ifndef VBOX_ROOT_CONFIG_KMK_INCLUDED
33	include $(PATH_ROOT)/Config.kmk
34	endif
35
36
37	#
38	# Globals.
39	#
40
41	# DITA stuff.
42	VBOX_DITA_CONVERTER_PATH ?= $(PATH_ROOT)/src/libs/dbdita-1.0
43	VBOX_DITA_ORIGINAL_PATH ?= $(PATH_ROOT)/src/libs/dita-ot-1.8.5
44
45
46	# Source location.
47	VBOX_PATH_MANUAL_SRC := $(PATH_ROOT)/doc/manual
48	# Output location.
49	VBOX_PATH_MANUAL_OUTBASE := $(PATH_OBJ)/manual
50
51	## List of refentry files (manpages).
52	VBOX_MANUAL_XML_REFENTRY_FILES := \
53	man_VBoxManage-common.xml \
54	man_VBoxManage-list.xml \
55	man_VBoxManage-showvminfo.xml \
56	man_VBoxManage-registervm.xml \
57	man_VBoxManage-unregistervm.xml \
58	man_VBoxManage-createvm.xml \
59	man_VBoxManage-modifyvm.xml \
60	man_VBoxManage-snapshot.xml \
61	man_VBoxManage-clonevm.xml \
62	man_VBoxManage-movevm.xml \
63	man_VBoxManage-encryptvm.xml \
64	man_VBoxManage-startvm.xml \
65	man_VBoxManage-controlvm.xml \
66	man_VBoxManage-import.xml \
67	man_VBoxManage-export.xml \
68	man_VBoxManage-mediumio.xml \
69	man_VBoxManage-sharedfolder.xml \
70	man_VBoxManage-dhcpserver.xml \
71	man_VBoxManage-debugvm.xml \
72	man_VBoxManage-extpack.xml \
73	man_VBoxManage-unattended.xml \
74	man_VBoxManage-cloud.xml \
75	man_VBoxManage-cloudprofile.xml \
76	man_VBoxManage-signova.xml \
77	man_VBoxManage-modifynvram.xml \
78	man_VBoxManage-hostonlynet.xml \
79	man_VBoxManage-updatecheck.xml \
80	man_VBoxManage-discardstate.xml \
81	man_VBoxManage-adoptstate.xml \
82	man_VBoxManage-closemedium.xml \
83	man_VBoxManage-storageattach.xml \
84	man_VBoxManage-storagectl.xml \
85	man_VBoxManage-bandwidthctl.xml \
86	man_VBoxManage-showmediuminfo.xml \
87	man_VBoxManage-createmedium.xml \
88	man_VBoxManage-modifymedium.xml \
89	man_VBoxManage-clonemedium.xml \
90	man_VBoxManage-mediumproperty.xml \
91	man_VBoxManage-encryptmedium.xml \
92	man_VBoxManage-checkmediumpwd.xml \
93	man_VBoxManage-convertfromraw.xml \
94	man_VBoxManage-setextradata.xml \
95	man_VBoxManage-getextradata.xml \
96	man_VBoxManage-setproperty.xml \
97	man_VBoxManage-usbfilter.xml \
98	man_VBoxManage-guestproperty.xml \
99	man_VBoxManage-guestcontrol.xml \
100	man_VBoxManage-metrics.xml \
101	man_VBoxManage-natnetwork.xml \
102	man_VBoxManage-hostonlyif.xml \
103	man_VBoxManage-usbdevsource.xml
104
105	## List of user manual XML files common for all languages.
106	VBOX_MANUAL_XML_FILES_COMMON = \
107	$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml
108
109
110	# Tool locations.
111	ifndef VBOX_OSE
112	# use docbook from our tools directory
113	VBOX_PATH_DOCBOOK ?= $(KBUILD_DEVTOOLS)/common/DocBook/v1.69.1
114	VBOX_PATH_DOCBOOK_DTD ?= $(KBUILD_DEVTOOLS)/common/docbook-xml/v4.5
115	else
116	# use docbook of the build host
117	VBOX_PATH_DOCBOOK ?= /usr/share/xml/docbook/stylesheet/docbook-xsl
118	VBOX_PATH_DOCBOOK_DTD ?= /usr/share/xml/docbook/schema/dtd/4.5
119	endif
120	VBOX_XML_CATALOG ?= $(VBOX_PATH_MANUAL_OUTBASE)/vbox-doc.cat
121	VBOX_XML_CATALOG_DOCBOOK ?= $(VBOX_PATH_MANUAL_OUTBASE)/docbook.cat
122	VBOX_XML_CATALOG_MANUAL ?= $(VBOX_PATH_MANUAL_OUTBASE)/manual.cat
123	VBOX_XML_ENTITIES ?= $(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent
124
125	# xsltproc with the catalog trick if applicable (set XML_DEBUG_CATALOG to
126	# non-zero value to debug file/uri resolution through the catalogs, using
127	# one of them is enough, they show the same information).
128	ifdef VBOX_XML_CATALOG
129	VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(if $(2),$(2),$(VBOX_XML_CATALOG))" -E "XML_DEBUG_CATALOG=" $1 -- \
130	$(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
131	VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" -- \
132	$(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
133	else
134	VBOX_XSLTPROC_WITH_CAT = $(if $(1), $(REDIRECT) $1 --,) $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) \
135	--path "$(VBOX_PATH_MANUAL_OUTBASE)"
136	VBOX_XMLLINT_WITH_CAT = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
137	endif
138
139
140	# File name of the generated stylesheet for transforming xref elements into
141	# name user manual sections.
142	VBOX_XML_XREF_TO_TEXT = xref-to-text.xsl
143
144	##
145	# Emits rules for preprocessing refentry sources (applying remarks element),
146	# and for producing the actual man pages.
147	#
148	# $(evalcall2 def_vbox_refentry_preprocess_for_manpage)
149	# @param 1 The output directory.
150	# @param 2 The XML file name (no path).
151	# @param 3 The XML file with full path.
152	# @param 4 Non-empty if xrefs to replace.
153	# @param 5 Language code (optional if $4 is empty).
154	define def_vbox_refentry_preprocess_for_manpage
155	$(1)/$(2): \
156	$(3) \
157	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
158	$(if $(4), $$(VBOX_PATH_MANUAL_OUTBASE)/$(5)/$$(VBOX_XML_XREF_TO_TEXT),) \
159	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
160	$$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
161	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
162	$$(QUIET)$$(RM) -f "$$@"
163	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
164	"$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl" $$<
165	ifneq ($(4),)
166	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@.tmp \
167	$$(VBOX_PATH_MANUAL_OUTBASE)/$(5)/$$(VBOX_XML_XREF_TO_TEXT) $$@
168	$$(QUIET)$$(MV) -f -- "$$@.tmp" "$$@"
169	endif
170	if defined(VBOX_HAVE_XMLLINT) && "$(USER)" == "bird" # Effing stuff happends on build servers, probably kmk related...
171	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
172	endif
173	endef
174
175	##
176	# Generate a single header file containing everything (no C file).
177	#
178	# @param 1 Destination file.
179	# @param 2 Full source file path.
180	# @param 3 Help infix.
181	define def_vbox_single_refentry_to_h
182	$(1).ts +\| $(1): \
183	$$(VBOX_DOCBOOK_REFENTRY_TO_C_HELP) \
184	$$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) \
185	$(2) \
186	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $(MAKEFILE) \| $$$$(dir $$$$@)
187	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(filter %.xml,$$^),$$(patsubst %.ts,%,$$@))
188	$$(QUIET)$$(APPEND) -tn "$$@" \
189	'/* Autogenerated by $$(notdir $$(filter %.xsl,$$^)), do not edit! */' \
190	'' \
191	'#include <iprt/message.h>' \
192	'#include <iprt/assertcompile.h>' \
193	'' \
194	'typedef enum HELP_CMD_$(3)' \
195	'{' \
196	' HELP_CMD_INVALID = 0,'
197	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") \
198	--stringparam 'g_sMode' 'cmd' $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) $(2)
199	$$(QUIET)$$(APPEND) -n "$$@" \
200	' HELP_CMD_END' \
201	'} HELP_CMD_VBOXMANAGE;' \
202	''
203	$$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") \
204	--stringparam 'g_sMode' 'subcmd' $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) $(2)
205	$$(QUIET)$$(APPEND) -n "$$@" \
206	''
207	$$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") $$(VBOX_DOCBOOK_REFENTRY_TO_C_HELP) $(2)
208	$$(QUIET)$$(APPEND) -n "$$@" \
209	'' \
210	'/* end of file */'
211	$$(QUIET)$$(CP) --changed -- "$$@" "$$(patsubst %.ts,%,$$@)"
212	endef
213
214
215	#
216	# Make sure we've got a rule to make the output directory.
217	#
218	BLDDIRS += $(VBOX_PATH_MANUAL_OUTBASE)
219
220
221	ifdef VBOX_XML_CATALOG
222	# Trickery for making sure that the file:/// URLs end up with exactly 3
223	# slashes, both on Unixy OSes (where the absolute path contributes one more,
224	# and some very picky xsltproc variants are floating around which do not work
225	# quite correctly with file:////, doing incorrect filename transformations)
226	# and on Windows (where the absolute path starts with a drive letter).
227	VBOX_FILE_URL_MAYBE_SLASH = $(if $(eq $(KBUILD_HOST),win),/,)
228	#
229	# To avoid network I/O for fetching DTDs, we generate catalogs mapping the public
230	# entity IDs to local files. (Obviously, only done when we have local files.)
231	#
232	# Create a catalog file for xsltproc that points to docbook catalog.
233	$(VBOX_XML_CATALOG): $(VBOX_PATH_MANUAL_SRC)/Config.kmk \| $$(dir $$@)
234	$(call MSG_L1,Creating catalog $@)
235	$(QUIET)$(APPEND) -tn "$@" \
236	'<?xml version="1.0"?>' \
237	'<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
238	'<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
239	' <delegatePublic publicIdStartString="-//OASIS/ENTITIES DocBook XML" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
240	' <delegatePublic publicIdStartString="-//OASIS/DTD DocBook XML" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
241	' <delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
242	' <delegateSystem systemIdStartString="http://docbook.org/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
243	' <delegateURI uriStartString="http://www.oasis-open.org/docbook/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
244	' <delegateURI uriStartString="http://docbook.org/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
245	' <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
246	' <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
247	' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
248	' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
249	' <delegateURI uriStartString="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
250	' <delegateURI uriStartString="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
251	'</catalog>'
252
253	# Create a docbook catalog file for xsltproc that points to the local docbook files.
254	$(VBOX_XML_CATALOG_DOCBOOK): $(VBOX_PATH_MANUAL_SRC)/Config.kmk \| $$(dir $$@)
255	$(call MSG_L1,Creating catalog $@)
256	$(QUIET)$(APPEND) -tn "$@" \
257	'<?xml version="1.0"?>' \
258	'<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
259	'<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
260	' <public publicId="-//OASIS//ELEMENTS DocBook XML Information Pool V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbpoolx.mod"/>' \
261	' <public publicId="-//OASIS//DTD DocBook XML V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd"/>' \
262	' <public publicId="-//OASIS//ENTITIES DocBook XML Character Entities V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbcentx.mod"/>' \
263	' <public publicId="-//OASIS//ENTITIES DocBook XML Notations V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbnotnx.mod"/>' \
264	' <public publicId="-//OASIS//ENTITIES DocBook XML Additional General Entities V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbgenent.mod"/>' \
265	' <public publicId="-//OASIS//ELEMENTS DocBook XML Document Hierarchy V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbhierx.mod"/>' \
266	' <public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/soextblx.dtd"/>' \
267	' <public publicId="-//OASIS//DTD DocBook XML CALS Table Model V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/calstblx.dtd"/>' \
268	' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
269	' <rewriteSystem systemIdStartString="http://docbook.org/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
270	' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
271	' <rewriteURI uriStartString="http://docbook.org/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
272	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsa.ent"/>' \
273	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsb.ent"/>' \
274	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsc.ent"/>' \
275	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsn.ent"/>' \
276	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amso.ent"/>' \
277	' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsr.ent"/>' \
278	' <public publicId="ISO 8879:1986//ENTITIES Box and Line Drawing//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-box.ent"/>' \
279	' <public publicId="ISO 8879:1986//ENTITIES Russian Cyrillic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr1.ent"/>' \
280	' <public publicId="ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr2.ent"/>' \
281	' <public publicId="ISO 8879:1986//ENTITIES Diacritical Marks//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-dia.ent"/>' \
282	' <public publicId="ISO 8879:1986//ENTITIES Greek Letters//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk1.ent"/>' \
283	' <public publicId="ISO 8879:1986//ENTITIES Monotoniko Greek//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk2.ent"/>' \
284	' <public publicId="ISO 8879:1986//ENTITIES Greek Symbols//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk3.ent"/>' \
285	' <public publicId="ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk4.ent"/>' \
286	' <public publicId="ISO 8879:1986//ENTITIES Added Latin 1//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat1.ent"/>' \
287	' <public publicId="ISO 8879:1986//ENTITIES Added Latin 2//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat2.ent"/>' \
288	' <public publicId="ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-num.ent"/>' \
289	' <public publicId="ISO 8879:1986//ENTITIES Publishing//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-pub.ent"/>' \
290	' <public publicId="ISO 8879:1986//ENTITIES General Technical//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-tech.ent"/>' \
291	'</catalog>'
292
293	# Create a docbook catalog file for xsltproc that points to the local manual files in non-default locations
294	$(VBOX_XML_CATALOG_MANUAL): $(VBOX_PATH_MANUAL_SRC)/Config.kmk \| $$(dir $$@)
295	$(call MSG_L1,Creating catalog $@)
296	$(QUIET)$(APPEND) -tn "$@" \
297	'<?xml version="1.0"?>' \
298	'<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
299	'<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
300	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-accessibility-ohc-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-accessibility-ohc-en.xml"/>' \
301	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-legal-notices/oracle-diversity.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-diversity.xml"/>' \
302	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-legal-notices/oracle-support-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-support-en.xml"/>' \
303	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/user_ChangeLogImpl.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml"/>' \
304	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl"/>' \
305	$(foreach x,user_VBoxManage_CommandsOverview.xml user_isomakercmd-man.xml $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_VBoxHeadless.xml man_vboximg-mount.xml)\
306	,' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/$(x)" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/en_US/$(x)"/>' \$(NLTAB)$(TAB)) \
307	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef_apiref.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml"/>' \
308	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/all-entities.ent" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent"/>' \
309	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/docbook.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/docbook.xsl"/>' \
310	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/chunk.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/chunk.xsl"/>' \
311	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/htmlhelp/htmlhelp.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/htmlhelp/htmlhelp.xsl"/>' \
312	' <system systemId="$(VBOX_PATH_MANUAL_SRC)/manpages/docbook.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/manpages/docbook.xsl"/>' \
313	'</catalog>'
314
315	endif # VBOX_XML_CATALOG
316
317
318	ifdef VBOX_XML_ENTITIES
319
320	$(VBOX_XML_ENTITIES): $(VBOX_PATH_MANUAL_SRC)/Config.kmk $(VBOX_VERSION_STAMP) \| $$(dir $$@)
321	$(call MSG_L1,Creating entities $@)
322	$(QUIET)$(APPEND) -tn "$@" \
323	'<!-- Entities for product names -->' \
324	'<!ENTITY product-version "$(VBOX_VERSION_STRING)">' \
325	'<!ENTITY product-name "Oracle VM VirtualBox">' \
326	'<!ENTITY vbox-mgr "VirtualBox Manager">' \
327	'<!ENTITY oci "Oracle Cloud Infrastructure">' \
328	'' \
329	'<!-- VBox placeholder entities -->' \
330	'<!ENTITY VBOX_VERSION_MAJOR "$(VBOX_VERSION_MAJOR)" >' \
331	'<!ENTITY VBOX_VERSION_MINOR "$(VBOX_VERSION_MINOR)" >' \
332	'<!ENTITY VBOX_VERSION_BUILD "$(VBOX_VERSION_BUILD)" >' \
333	'<!ENTITY VBOX_VERSION_STRING "$(VBOX_VERSION_STRING)" >' \
334	'<!ENTITY VBOX_VENDOR "$(VBOX_VENDOR)" >' \
335	'<!ENTITY VBOX_C_YEAR "$(VBOX_C_YEAR)" >' \
336	'<!ENTITY VBOX_PRODUCT '\''<trademark class="registered">Oracle</trademark> VM <trademark class="registered">VirtualBox</trademark>'\'' >' \
337	'' \
338	'<!-- Entities for Oracle Help Center -->' \
339	'<!ENTITY ohc-base-url "https://docs.oracle.com/en">' \
340	'<!ENTITY ohc-doc-page "&ohc-base-url;/virtualization/virtualbox/index.html">'
341
342	endif # VBOX_XML_ENTITIES
343
344
345	## Emit rules to produce a stylesheet for translating cross references (xref)
346	# to user manual chapters and sections in the man pages and --help output.
347	#
348	# Note! This is a bit hackish, as it only processes the checked in .dita files
349	# and not the processed result nor stuff we generated. Seems like all
350	# we generate is manpage related pages, so that's fine since these are
351	# all currently at the tail of one chapter in the manual.
352	#
353	# If it turns out we generate more stuff that this, we're in for lots of
354	# dependency fun with VBoxManage and the RTIsoMaker (+ derivatives).
355	#
356	# $(evalcall2 def_vbox_xref_to_text)
357	# @param 1 Language code.
358	define def_vbox_xref_to_text
359	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
360	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat: \
361	$$(VBOX_PATH_MANUAL_SRC)/$(1)/docbook-refentry-link-replacement-xsl-gen.xsl \
362	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-link-replacement-xsl-gen.xsl \
363	$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita-refentry-link-replacement-xsl-gen.xsl \
364	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-link-replacement-xsl-gen.xsl \
365	$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl \
366	$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/UserManual.ditamap \
367	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/*.xml) \
368	$$(VBOX_MANUAL_XML_FILES_COMMON) \
369	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $$(VBOX_XML_ENTITIES) \
370	\| $$$$(dir $$$$@)
371	$$(call MSG_L1,Creating stylesheet $$@)
372	$$(QUIET)$$(APPEND) -nt "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat" \
373	'<?xml version="1.0"?>' \
374	'<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
375	'<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
376	$$(foreach x, vboxmanage-cmd-overview.dita \
377	,' <system systemId="$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/topics/$$(x)" uri="file://$$(VBOX_FILE_URL_MAYBE_SLASH)$$(VBOX_PATH_MANUAL_SRC)/dummy-topic.dita"/>' \$$(NLTAB)$$(TAB)) \
378	' <nextCatalog catalog="file://$$(VBOX_FILE_URL_MAYBE_SLASH)$$(VBOX_XML_CATALOG)"/>' \
379	'</catalog>'
380	cat "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat"
381	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
382	--output "$$@.tmp.xml" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" $$(filter %.ditamap,$$^)
383	if 0 # Enable to see the full combined document.
384	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
385	--path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
386	--path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
387	--path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
388	--output "$$@.tmp2.xml" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" "$$@.tmp.xml"
389	endif
390	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
391	--path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
392	--path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
393	--path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
394	--stringparam 'g_sMode' 'first' \
395	--output "$$@" \
396	"$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita-refentry-link-replacement-xsl-gen.xsl" \
397	"$$@.tmp.xml"
398	# Using en-US version as section and chapter names until user manual is translated as well
399	$$(foreach x, $$(VBOX_MANUAL_XML_REFENTRY_FILES)\
400	,$$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -ato "$$@") --stringparam 'g_sMode' 'append' \
401	"$$<" "$$(VBOX_PATH_MANUAL_SRC)/en_US/$$(x)")
402	$$(QUIET)$$(APPEND) -n "$$@" '' '</xsl:stylesheet>'
403	$$(QUIET)$$(RM) -f -- "$$@.tmp.xml"
404
405	BLDDIRS += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/
406	endef
407	# generate rules for $(VBOX_XML_XREF_TO_TEXT)
408	$(evalcall2 def_vbox_xref_to_text,en_US)
409
410	#
411	# Generate rules for editing the refentry to C/H style sheets.
412	#
413	VBOX_DOCBOOK_REFENTRY_TO_C_HELP = $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-C-help.xsl
414
415	VBOX_DOCBOOK_REFENTRY_TO_H_HELP = $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-H-help.xsl
416
417	#
418	# Manual dependency.
419	#
420	$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-C-help.xsl: $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl
421
422
423	endif # !defined(VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED)
424

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

Download in other formats:

Original Format