Changeset 77353 in vbox
- Timestamp:
- Feb 18, 2019 9:15:47 PM (6 years ago)
- Location:
- trunk
- Files:
-
- 1 added
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/Config.kmk
r76786 r77353 40 40 man_VBoxManage-extpack.xml \ 41 41 man_VBoxManage-unattended.xml 42 43 ## List of user manual XML files. 44 VBOX_MANUAL_XML_FILES = \ 45 UserManual.xml \ 46 user_Preface.xml \ 47 user_Introduction.xml \ 48 user_Installation.xml \ 49 user_BasicConcepts.xml \ 50 user_GuestAdditions.xml \ 51 user_Storage.xml \ 52 user_Networking.xml \ 53 user_Frontends.xml \ 54 user_VBoxManage.xml \ 55 user_AdvancedTopics.xml \ 56 user_Technical.xml \ 57 user_VirtualBoxAPI.xml \ 58 user_Troubleshooting.xml \ 59 user_Security.xml \ 60 user_KnownIssues.xml \ 61 user_ChangeLog.xml \ 62 user_ThirdParty.xml \ 63 user_PrivacyPolicy.xml \ 64 user_Glossary.xml \ 65 oracle-accessibility-en.xml \ 66 oracle-support-en.xml 67 68 ## List of user manual XML files common for all languages. 69 VBOX_MANUAL_XML_FILES_COMMON = \ 70 $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml 42 71 43 72 … … 62 91 ifdef VBOX_XML_CATALOG 63 92 VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" $1 -- \ 64 $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) 93 $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)" 65 94 VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" -- \ 66 $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) 95 $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)" 67 96 else 68 VBOX_XSLTPROC_WITH_CAT = $(if $(1), $(REDIRECT) $1 --,) $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) 69 VBOX_XMLLINT_WITH_CAT = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) 70 endif 71 97 VBOX_XSLTPROC_WITH_CAT = $(if $(1), $(REDIRECT) $1 --,) $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) \ 98 --path "$(VBOX_PATH_MANUAL_OUTBASE)" 99 VBOX_XMLLINT_WITH_CAT = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)" 100 endif 101 102 103 # Location of the generate stylesheet for transformating xref elements into 104 # name user manual sections. 105 VBOX_XML_XREF_TO_TEXT = $(VBOX_PATH_MANUAL_OUTBASE)/xref-to-text.xsl 72 106 73 107 ## … … 79 113 # @param 2 The XML file name (no path). 80 114 # @param 3 The XML file with full path. 115 # @param 4 Non-empty if xrefs to replace. 81 116 define def_vbox_refentry_preprocess_for_manpage 82 117 $(1)/$(2): \ 83 118 $(3) \ 84 119 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \ 120 $(if $(4),$$(VBOX_XML_XREF_TO_TEXT),) \ 85 121 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \ 86 122 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@) … … 88 124 $$(QUIET)$$(RM) -f "$$@" 89 125 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \ 90 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$< 126 "$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl" $$< 127 ifneq ($(4),) 128 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_XML_XREF_TO_TEXT) $$@ 129 $$(QUIET)$$(MV) -f -- "[email protected]" "$$@" 130 endif 91 131 if defined(VBOX_HAVE_XMLLINT) && "$(USER)" == "bird" # Effing stuff happends on build servers, probably kmk related... 92 132 $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@ … … 238 278 $(call MSG_L1,Creating entities $@) 239 279 $(QUIET)$(APPEND) -tn "$@" \ 240 280 '<!-- Entities for product names -->' \ 241 281 '<!ENTITY product-version "$(VBOX_VERSION_STRING)">' \ 242 282 '<!ENTITY product-name "Oracle VM VirtualBox">' \ … … 259 299 260 300 301 ## Produce stylesheet for translating cross references (xref) to user manual 302 # chapters and sections in the man pages and --help output. 303 # 304 # Note! This requires processing UserManual.xml as a single document in order 305 # to get the correct chapter and section numbering, so we use a catalog 306 # file to replace the generated XML documents it includes with a dummy 307 # one. This reduces the dependencies and recipies we require to build 308 # VBoxManage and the RTIsoMaker (w/ derivatives). 309 $(VBOX_XML_XREF_TO_TEXT) + $(VBOX_XML_XREF_TO_TEXT).cat: \ 310 $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-link-replacement-xsl-gen.xsl \ 311 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \ 312 $(VBOX_MANUAL_XML_FILES_COMMON) \ 313 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) $(VBOX_XML_ENTITIES) \ 314 | $$(dir $$@) 315 $(call MSG_L1,Creating stylesheet $@) 316 $(QUIET)$(APPEND) -nt "$(VBOX_XML_XREF_TO_TEXT).cat" \ 317 '<?xml version="1.0"?>' \ 318 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \ 319 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \ 320 $(foreach x,user_VBoxManage_CommandsOverview.xml user_isomakercmd-man.xml $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES))\ 321 ,' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/$(x)" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/dummy-sect1.xml"/>') \ 322 ' <nextCatalog catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG)"/>' \ 323 '</catalog>' 324 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT, -E "XML_CATALOG_FILES=$(VBOX_XML_XREF_TO_TEXT).cat") \ 325 --output "$@" "$<" $(filter %UserManual.xml,$^) 326 261 327 # 262 328 # Generate rules for editing the refentry to C/H style sheets. -
trunk/doc/manual/Makefile.kmk
r77312 r77353 131 131 BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES)) 132 132 133 134 133 if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK)) 135 134 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF) … … 183 182 endif 184 183 185 VBOX_MANUAL_XML_FILES = \186 UserManual.xml \187 user_Preface.xml \188 user_Introduction.xml \189 user_Installation.xml \190 user_BasicConcepts.xml \191 user_GuestAdditions.xml \192 user_Storage.xml \193 user_Networking.xml \194 user_Frontends.xml \195 user_VBoxManage.xml \196 user_AdvancedTopics.xml \197 user_Technical.xml \198 user_VirtualBoxAPI.xml \199 user_Troubleshooting.xml \200 user_Security.xml \201 user_KnownIssues.xml \202 user_ChangeLog.xml \203 user_ThirdParty.xml \204 user_PrivacyPolicy.xml \205 user_Glossary.xml \206 oracle-accessibility-en.xml \207 oracle-support-en.xml208 209 VBOX_MANUAL_XML_FILES_COMMON = \210 $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml211 212 184 $(foreach lang,$(VBOX_MANUAL_LANGUAGES), \ 213 185 $(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \ … … 256 228 $(VBOX_XML_CATALOG_MANUAL) \ 257 229 $(VBOX_XML_ENTITIES) \ 230 $(VBOX_XML_XREF_TO_TEXT) \ 231 $(VBOX_XML_XREF_TO_TEXT).cat \ 258 232 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \ 259 233 $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \ 234 $(VBOX_MANUAL_XML_REFENTRY_FILES) \ 260 235 $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \ 261 236 isomakercmd-man.xml \ … … 872 847 $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \ 873 848 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \ 849 $$(VBOX_XML_XREF_TO_TEXT) \ 874 850 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \ 875 851 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@) … … 878 854 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \ 879 855 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$< 856 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_XML_XREF_TO_TEXT) $$@ 857 $$(QUIET)$$(MV) -f -- "[email protected]" "$$@" 880 858 if defined(VBOX_HAVE_XMLLINT) 881 859 $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@ -
trunk/doc/manual/en_US/man_VBoxManage-debugvm.xml
r73276 r77353 128 128 129 129 <para>The "debugvm" commands are for experts who want to tinker with the 130 exact details of virtual machine execution. Like the VM debugger <remark role="help-manual">131 described in <xref linkend="ts_debugger" /> </remark>, these commands are only useful if you are130 exact details of virtual machine execution. Like the VM debugger 131 described in <xref linkend="ts_debugger" />, these commands are only useful if you are 132 132 very familiar with the details of the PC architecture and how to debug 133 133 software.</para> … … 151 151 <para> 152 152 Creates a system dump file of the specified VM. This file will have 153 the standard ELF core format (with custom sections) <remark role="help-manual">; see154 <xref linkend="ts_guest-core-format" /> </remark>.153 the standard ELF core format (with custom sections); see 154 <xref linkend="ts_guest-core-format" />. 155 155 </para> 156 156 <para> -
trunk/src/VBox/Frontends/VBoxManage/Makefile.kmk
r76553 r77353 132 132 # Preprocess the xml files, applying remarks. 133 133 $(foreach file,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \ 134 , $(evalcall2 def_vbox_refentry_preprocess_for_manpage,$(VBoxManage_0_OUTDIR),$(file),$(VBOX_PATH_MANUAL_SRC)/en_US/$(file) ))134 , $(evalcall2 def_vbox_refentry_preprocess_for_manpage,$(VBoxManage_0_OUTDIR),$(file),$(VBOX_PATH_MANUAL_SRC)/en_US/$(file),replace-xrefs)) 135 135 136 136
Note:
See TracChangeset
for help on using the changeset viewer.