diff options
| -rw-r--r-- | Config.kmk | 11 | ||||
| -rw-r--r-- | Makefile.kmk | 6 | ||||
| -rw-r--r-- | doc/manual/Makefile.kmk | 77 | ||||
| -rw-r--r-- | src/VBox/Installer/linux/Makefile.kmk | 5 | ||||
| -rw-r--r-- | src/VBox/Installer/solaris/Makefile.kmk | 2 | ||||
| -rw-r--r-- | src/VBox/Installer/win/Makefile.kmk | 12 |
6 files changed, 2 insertions, 111 deletions
diff --git a/Config.kmk b/Config.kmk index 273a83cab87..ebb57c1ef03 100644 --- a/Config.kmk +++ b/Config.kmk @@ -441,12 +441,6 @@ VBOX_WITH_DOCS = 1 #VBOX_WITH_DOCS_FROM_BUILD_SERVER = 1 # Include documentation in the package VBOX_WITH_DOCS_PACKING = 1 -# Include CHM when building docs (unset in LocalConfig.kmk to suppress CHM) -## @todo CHM docs are on the way out... -if1of ($(KBUILD_TARGET), win) - VBOX_WITH_DOCS_CHM = - VBOX_WITH_DOCS_CHM_PACKING = -endif # Build QHelp documentation, needs qhelpgenerator VBOX_WITH_DOCS_QHELP = 1 # Include QHelp documentation in the package @@ -1424,8 +1418,6 @@ endif # For the docs build box. # ifdef VBOX_ONLY_DOCS - # Phase out the .chm docs - VBOX_WITH_DOCS_CHM = # Always produce HTML docs (for publishing on website as part of release) VBOX_WITH_DOCS_HTML = 1 # Always produce QHelp docs (for help in the UI, replacing CHM) @@ -1566,7 +1558,8 @@ endif ifdef VBOX_WITHOUT_DOCS # Zap anything that could be contradicting this. VBOX_WITH_DOCS := - VBOX_WITH_DOCS_CHM := + VBOX_WITH_DOCS_QHELP := + VBOX_WITH_DOCS_HTML := endif # diff --git a/Makefile.kmk b/Makefile.kmk index 71b7fe12e96..a39d71fb9c8 100644 --- a/Makefile.kmk +++ b/Makefile.kmk @@ -407,11 +407,9 @@ if !defined(VBOX_ONLY_ADDITIONS) \ buildserver-docs_MODE = 0644 buildserver-docs_SOURCES = \ $(addprefix $(PATH_TARGET)/, \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox.chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual.qch UserManual.qhc,) \ UserManual.pdf \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox_$(f).chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual_$(f).qch UserManual_$(f).qhc,) \ UserManual_$(f).pdf)) buildserver-docs_CLEANS = \ @@ -426,22 +424,18 @@ if !defined(VBOX_ONLY_ADDITIONS) \ UserManual_$(f).pdf)) $$(buildserver-docs_0_OUTDIR)/unpacked.ts +| \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual.qch $(PATH_TARGET)/UserManual.qhc,) \ $(PATH_TARGET)/UserManual.pdf \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox_$(f).chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual_$(f).qch $(PATH_TARGET)/UserManual_$(f).qhc,) \ $(PATH_TARGET)/UserManual_$(f).pdf): \ $$(buildserver-docs_0_OUTDIR)/VBoxDocumentation.zip $(call MSG_L1,Unpacking documentation) $(QUIET)$(TOOL_ZIP_UNPACK) $(TOOL_ZIP_UNPACKFLAGS) -o $< -d $(PATH_TARGET) $(TOUCH) -c -- \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual.qch $(PATH_TARGET)/UserManual.qhc,) \ $(PATH_TARGET)/UserManual.pdf \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox_$(f).chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual_$(f).qch $(PATH_TARGET)/UserManual_$(f).qhc,) \ $(PATH_TARGET)/UserManual_$(f).pdf) $(APPEND) -t $@ "done" diff --git a/doc/manual/Makefile.kmk b/doc/manual/Makefile.kmk index ade244af5d9..1dee08fa4f4 100644 --- a/doc/manual/Makefile.kmk +++ b/doc/manual/Makefile.kmk @@ -31,7 +31,6 @@ # # -- UserManual.pdf, generated by LaTex # -# -- VirtualBox.chm # # Both files end up in PATH_STAGE_BIN. # @@ -50,9 +49,6 @@ # to UserManual.tex. This is then regularly processed by pdflatex to # generate PDF. # -# -- CHM file: again, pre-process the XML files in PATH_TARGET, then use -# xsltproc to create a .HHP file for the Microsoft Help Compiler, then -# feed that file to it. # SUB_DEPTH = ../.. @@ -154,13 +150,6 @@ if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DO VBOX_PATH_BIN_HTML = endif - ifdef VBOX_WITH_DOCS_CHM - INSTALLS += VBox-docs-usermanual-chm - VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm - else # Do not build chm. - VBOX_PATH_BIN_CHM = - endif - ifdef VBOX_WITH_DOCS_QHELP INSTALLS += VBox-docs-usermanual-qhc INSTALLS += VBox-docs-usermanual-qch @@ -197,11 +186,6 @@ if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DO INSTALLS += VBox-docs-usermanual-l10n VBOX_MANUAL_PACK += \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) - ifdef VBOX_WITH_DOCS_CHM - INSTALLS += VBox-docs-usermanual-l10n-chm - VBOX_MANUAL_PACK += \ - $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) - endif endif endif # !VBOX_ONLY_SDK @@ -722,67 +706,6 @@ man_vboximg-mount.xml \ $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o $@.tmp $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $< $(QUIET)$(MV) -f $@.tmp $@ - - ifdef VBOX_WITH_DOCS_CHM - # - # VirtualBox.chm - # - # We first generate a .hhp help source file from the preprocessed - # DocBook XML files, as defined above, then feed that into the - # Microsoft Help Compiler. - - # Generate CHM from HHP - # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input. - define def_vbox_usermanual_hhp_to_chm - local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang) - $$(out_dir)/VirtualBox.chm: \ - $$(out_dir)/HTMLHelp/htmlhelp.hhp \ - $$(addprefix $$(out_dir)/HTMLHelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \ - | $$$$(dir $$$$@) - $$(call MSG_L1,hhc $$<,=> $$@) - $$(QUIET)$$(RM) -f $$@ - $$(QUIET)$$(VBOX_HHC) $$(subst /,\\,$$<) - $$(call MSG_L1,Fresh CHM is now at $$@) - endef - $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_to_chm)) - - # Generate HHP from XML - # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input. - define def_vbox_usermanual_xml_to_hhp - local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang) - $$(out_dir)/HTMLHelp/htmlhelp.hhp: \ - $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \ - $$(VBOX_MANUAL_XML_FILES_COMMON) \ - $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \ - $$(VBOX_DOCBOOK_HTMLHELP_FORMATCFG) \ - $$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \ - $$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \ - $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \ - $$(VBOX_XML_ENTITIES) | $$$$(dir $$$$@) - $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@) - $$(QUIET)$$(RM) -f $$@ - $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$(@D)/ \ - --stringparam htmlhelp.chm \ - $$(subst /,\\,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/VirtualBox.chm) \ - $$(HTMLHELPOPTS) $$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \ - $$< - endef - $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_hhp)) - - # copy the PNG files. - # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input. - define def_vbox_cp_images_htmlhelp - local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp - $(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \ - $$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@) - $$(call MSG_L1,Copying temporary $$< => $$@) - $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)' - endef - $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp))) - - endif # VBOX_WITH_DOCS_CHM - - # Packing the docs into a zip file $(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK) $(call MSG_L1,Packing documentation $@) diff --git a/src/VBox/Installer/linux/Makefile.kmk b/src/VBox/Installer/linux/Makefile.kmk index b1c1af5e29c..d09e8573111 100644 --- a/src/VBox/Installer/linux/Makefile.kmk +++ b/src/VBox/Installer/linux/Makefile.kmk @@ -290,11 +290,6 @@ ifdef VBOX_WITH_DOCS_PACKING VBOX_LNX_NO_STRIP += \ UserManual.pdf \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),UserManual_$(f).pdf) - ifdef VBOX_WITH_DOCS_CHM_PACKING - VBOX_LNX_NO_STRIP += \ - VirtualBox.chm \ - $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),VirtualBox_$(f).chm) - endif ifdef VBOX_WITH_DOCS_QHELP_PACKING VBOX_LNX_NO_STRIP += \ UserManual.qch UserManual.qhc \ diff --git a/src/VBox/Installer/solaris/Makefile.kmk b/src/VBox/Installer/solaris/Makefile.kmk index de9b491b5fa..d03ce341f8d 100644 --- a/src/VBox/Installer/solaris/Makefile.kmk +++ b/src/VBox/Installer/solaris/Makefile.kmk @@ -441,11 +441,9 @@ SOLARIS_COMMON_EXES += \ # Documentation (packed as DOCS as they are arch. neutral) ifdef VBOX_WITH_DOCS_PACKING SOLARIS_COMMON += \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox.chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual.qch UserManual.qhc,) \ UserManual.pdf \ $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \ - $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox_$(f).chm,) \ $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual_$(f).qch UserManual_$(f).qhc,) \ UserManual_$(f).pdf) endif diff --git a/src/VBox/Installer/win/Makefile.kmk b/src/VBox/Installer/win/Makefile.kmk index ae284a0426c..5463f12db03 100644 --- a/src/VBox/Installer/win/Makefile.kmk +++ b/src/VBox/Installer/win/Makefile.kmk @@ -369,11 +369,6 @@ $(VBOX_WIN_INST_OUT_DIR)/Files_Main.wxi: $(VBOX_WIN_INST_MAKEFILE_DEP) | $$(dir $(APPEND) -t $@ '<?xml version="1.0" ?>' $(APPEND) $@ '<Include xmlns="http://schemas.microsoft.com/wix/2006/wi">' ifdef VBOX_WITH_DOCS_PACKING - ifdef VBOX_WITH_DOCS_CHM_PACKING - $(APPEND) $@ ' <File Id="file_VirtualBox.chm" Name="VirtualBox.chm" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/VirtualBox.chm)"></File>' - $(APPEND) -n $@ $(foreach lang,$(VBOX_MANUAL_ADD_LANGUAGES), \ - ' <File Id="file_VirtualBox_$(lang).chm" Name="VirtualBox_$(lang).chm" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/VirtualBox_$(lang).chm)"></File>') - endif ifdef VBOX_WITH_DOCS_QHELP_PACKING $(APPEND) $@ ' <File Id="file_UserManual.qch" Name="UserManual.qch" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/UserManual.qch)"></File>' $(APPEND) $@ ' <File Id="file_UserManual.qhc" Name="UserManual.qhc" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/UserManual.qhc)"></File>' @@ -456,13 +451,6 @@ $(VBOX_WIN_INST_OUT_DIR)/Shortcuts_StartMenu.wxi: $(VBOX_WIN_INST_MAKEFILE_DEP) # Documentation (PDF/CHM) # ifdef VBOX_WITH_DOCS_PACKING - ifdef VBOX_WITH_DOCS_CHM_PACKING - $(APPEND) $@ ' <Shortcut Id="sc_StartMenu_ManualCHM_en_US" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (CHM, English)" Description="!(loc.StartMenu_UserManual)"' \ - ' Target="[INSTALLDIR]\VirtualBox.chm" WorkingDirectory="dir_Documents" Advertise="no"/>' - $(APPEND) -n $@ $(foreach lang,$(VBOX_MANUAL_ADD_LANGUAGES), \ - ' <Shortcut Id="sc_StartMenu_ManualCHM_$(lang)" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (CHM, $(VBOX_BRAND_$(lang)_LANG_NAME))"' \ - ' Description="!(loc.StartMenu_UserManual) ($(VBOX_BRAND_$(lang)_LANG_NAME))" Target="[INSTALLDIR]\VirtualBox_$(lang).chm" WorkingDirectory="dir_Documents"/>') - endif $(APPEND) $@ ' <Shortcut Id="sc_StartMenu_ManualPDF_en_US" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (PDF, English)" Description="!(loc.StartMenu_UserManual)"' \ ' Target="[INSTALLDIR]\doc\UserManual.pdf" WorkingDirectory="dir_Documents" Advertise="no"/>' $(APPEND) -n $@ $(foreach lang,$(VBOX_MANUAL_ADD_LANGUAGES), \ |