VirtualBox

Changeset 98932 in vbox for trunk


Ignore:
Timestamp:
Mar 13, 2023 1:04:22 PM (19 months ago)
Author:
vboxsync
Message:

Docs: Removing CHM related bits.

Location:
trunk
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/Config.kmk

    r98886 r98932  
    442442# Include documentation in the package
    443443VBOX_WITH_DOCS_PACKING = 1
    444 # Include CHM when building docs (unset in LocalConfig.kmk to suppress CHM)
    445 ## @todo CHM docs are on the way out...
    446 if1of ($(KBUILD_TARGET), win)
    447  VBOX_WITH_DOCS_CHM =
    448  VBOX_WITH_DOCS_CHM_PACKING =
    449 endif
    450444# Build QHelp documentation, needs qhelpgenerator
    451445VBOX_WITH_DOCS_QHELP = 1
     
    14251419#
    14261420ifdef VBOX_ONLY_DOCS
    1427  # Phase out the .chm docs
    1428  VBOX_WITH_DOCS_CHM =
    14291421 # Always produce HTML docs (for publishing on website as part of release)
    14301422 VBOX_WITH_DOCS_HTML = 1
     
    15671559 # Zap anything that could be contradicting this.
    15681560 VBOX_WITH_DOCS :=
    1569  VBOX_WITH_DOCS_CHM :=
     1561 VBOX_WITH_DOCS_QHELP :=
     1562 VBOX_WITH_DOCS_HTML :=
    15701563endif
    15711564
  • trunk/Makefile.kmk

    r98920 r98932  
    408408  buildserver-docs_SOURCES = \
    409409        $(addprefix $(PATH_TARGET)/, \
    410         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox.chm,) \
    411410        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual.qch UserManual.qhc,) \
    412411        UserManual.pdf \
    413412        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
    414         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox_$(f).chm,) \
    415413        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual_$(f).qch UserManual_$(f).qhc,) \
    416414        UserManual_$(f).pdf))
     
    427425
    428426  $$(buildserver-docs_0_OUTDIR)/unpacked.ts +| \
    429   $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \
    430427  $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual.qch $(PATH_TARGET)/UserManual.qhc,) \
    431428  $(PATH_TARGET)/UserManual.pdf \
    432429  $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
    433         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox_$(f).chm,) \
    434430        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual_$(f).qch $(PATH_TARGET)/UserManual_$(f).qhc,) \
    435431        $(PATH_TARGET)/UserManual_$(f).pdf): \
     
    438434        $(QUIET)$(TOOL_ZIP_UNPACK) $(TOOL_ZIP_UNPACKFLAGS) -o $< -d $(PATH_TARGET)
    439435        $(TOUCH) -c -- \
    440                 $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \
    441436                $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual.qch $(PATH_TARGET)/UserManual.qhc,) \
    442437                $(PATH_TARGET)/UserManual.pdf \
    443438                $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
    444                         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox_$(f).chm,) \
    445439                        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),$(PATH_TARGET)/UserManual_$(f).qch $(PATH_TARGET)/UserManual_$(f).qhc,) \
    446440                        $(PATH_TARGET)/UserManual_$(f).pdf)
  • trunk/doc/manual/Makefile.kmk

    r98901 r98932  
    3232#   -- UserManual.pdf, generated by LaTex
    3333#
    34 #   -- VirtualBox.chm
    3534#
    3635#   Both files end up in PATH_STAGE_BIN.
     
    5150#      generate PDF.
    5251#
    53 #   -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
    54 #      xsltproc to create a .HHP file for the Microsoft Help Compiler, then
    55 #      feed that file to it.
    5652#
    5753
     
    155151 endif
    156152
    157  ifdef VBOX_WITH_DOCS_CHM
    158   INSTALLS += VBox-docs-usermanual-chm
    159   VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
    160  else  # Do not build chm.
    161   VBOX_PATH_BIN_CHM =
    162  endif
    163 
    164153 ifdef VBOX_WITH_DOCS_QHELP
    165154  INSTALLS += VBox-docs-usermanual-qhc
     
    198187   VBOX_MANUAL_PACK += \
    199188        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
    200    ifdef VBOX_WITH_DOCS_CHM
    201     INSTALLS += VBox-docs-usermanual-l10n-chm
    202     VBOX_MANUAL_PACK += \
    203         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    204    endif
    205189  endif
    206190 endif # !VBOX_ONLY_SDK
     
    723707        $(QUIET)$(MV) -f $@.tmp $@
    724708
    725 
    726  ifdef VBOX_WITH_DOCS_CHM
    727   #
    728   # VirtualBox.chm
    729   #
    730   # We first generate a .hhp help source file from the preprocessed
    731   # DocBook XML files, as defined above, then feed that into the
    732   # Microsoft Help Compiler.
    733 
    734   # Generate CHM from HHP
    735   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    736   define def_vbox_usermanual_hhp_to_chm
    737    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
    738    $$(out_dir)/VirtualBox.chm: \
    739                 $$(out_dir)/HTMLHelp/htmlhelp.hhp \
    740                 $$(addprefix $$(out_dir)/HTMLHelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
    741                 | $$$$(dir $$$$@)
    742         $$(call MSG_L1,hhc $$<,=> $$@)
    743         $$(QUIET)$$(RM) -f $$@
    744         $$(QUIET)$$(VBOX_HHC) $$(subst /,\\,$$<)
    745         $$(call MSG_L1,Fresh CHM is now at $$@)
    746   endef
    747   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_to_chm))
    748 
    749   # Generate HHP from XML
    750   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    751   define def_vbox_usermanual_xml_to_hhp
    752    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
    753    $$(out_dir)/HTMLHelp/htmlhelp.hhp: \
    754                 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
    755                 $$(VBOX_MANUAL_XML_FILES_COMMON) \
    756                 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
    757                 $$(VBOX_DOCBOOK_HTMLHELP_FORMATCFG) \
    758                 $$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
    759                 $$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
    760                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
    761                 $$(VBOX_XML_ENTITIES) | $$$$(dir $$$$@)
    762         $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
    763         $$(QUIET)$$(RM) -f $$@
    764         $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$(@D)/ \
    765                 --stringparam htmlhelp.chm \
    766                 $$(subst /,\\,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/VirtualBox.chm) \
    767                 $$(HTMLHELPOPTS) $$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
    768                 $$<
    769   endef
    770   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_hhp))
    771 
    772   # copy the PNG files.
    773   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    774   define def_vbox_cp_images_htmlhelp
    775    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
    776    $(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
    777                 $$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
    778         $$(call MSG_L1,Copying temporary $$< => $$@)
    779         $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
    780   endef
    781   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp)))
    782 
    783  endif # VBOX_WITH_DOCS_CHM
    784 
    785 
    786709 # Packing the docs into a zip file
    787710 $(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
  • trunk/src/VBox/Installer/linux/Makefile.kmk

    r98680 r98932  
    291291        UserManual.pdf \
    292292        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),UserManual_$(f).pdf)
    293  ifdef VBOX_WITH_DOCS_CHM_PACKING
    294   VBOX_LNX_NO_STRIP += \
    295         VirtualBox.chm \
    296         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),VirtualBox_$(f).chm)
    297  endif
    298293 ifdef VBOX_WITH_DOCS_QHELP_PACKING
    299294  VBOX_LNX_NO_STRIP += \
  • trunk/src/VBox/Installer/solaris/Makefile.kmk

    r98697 r98932  
    442442ifdef VBOX_WITH_DOCS_PACKING
    443443 SOLARIS_COMMON += \
    444         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox.chm,) \
    445444        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual.qch UserManual.qhc,) \
    446445        UserManual.pdf \
    447446        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
    448         $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox_$(f).chm,) \
    449447        $(if-expr defined(VBOX_WITH_DOCS_QHELP_PACKING),UserManual_$(f).qch UserManual_$(f).qhc,) \
    450448        UserManual_$(f).pdf)
  • trunk/src/VBox/Installer/win/Makefile.kmk

    r98911 r98932  
    370370        $(APPEND) $@ '<Include xmlns="http://schemas.microsoft.com/wix/2006/wi">'
    371371ifdef VBOX_WITH_DOCS_PACKING
    372  ifdef VBOX_WITH_DOCS_CHM_PACKING
    373         $(APPEND) $@ '  <File Id="file_VirtualBox.chm" Name="VirtualBox.chm" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/VirtualBox.chm)"></File>'
    374         $(APPEND) -n $@ $(foreach lang,$(VBOX_MANUAL_ADD_LANGUAGES), \
    375                      '  <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>')
    376  endif
    377372 ifdef VBOX_WITH_DOCS_QHELP_PACKING
    378373        $(APPEND) $@ '  <File Id="file_UserManual.qch" Name="UserManual.qch" DiskId="$(VBOX_INSTALLER_COMMON_DISKID)" Vital="yes" Source="$(subst /,\,$(PATH_STAGE_BIN)/UserManual.qch)"></File>'
     
    457452        #
    458453ifdef VBOX_WITH_DOCS_PACKING
    459  ifdef VBOX_WITH_DOCS_CHM_PACKING
    460         $(APPEND) $@ '  <Shortcut Id="sc_StartMenu_ManualCHM_en_US" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (CHM, English)" Description="!(loc.StartMenu_UserManual)"' \
    461                      '            Target="[INSTALLDIR]\VirtualBox.chm" WorkingDirectory="dir_Documents" Advertise="no"/>'
    462         $(APPEND) -n $@ $(foreach lang,$(VBOX_MANUAL_ADD_LANGUAGES), \
    463                      '  <Shortcut Id="sc_StartMenu_ManualCHM_$(lang)" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (CHM, $(VBOX_BRAND_$(lang)_LANG_NAME))"' \
    464                      '            Description="!(loc.StartMenu_UserManual) ($(VBOX_BRAND_$(lang)_LANG_NAME))" Target="[INSTALLDIR]\VirtualBox_$(lang).chm" WorkingDirectory="dir_Documents"/>')
    465  endif
    466454        $(APPEND) $@ '  <Shortcut Id="sc_StartMenu_ManualPDF_en_US" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (PDF, English)" Description="!(loc.StartMenu_UserManual)"' \
    467455                     '            Target="[INSTALLDIR]\doc\UserManual.pdf" WorkingDirectory="dir_Documents" Advertise="no"/>'
Note: See TracChangeset for help on using the changeset viewer.

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