Changeset 88303 in vbox for trunk

Timestamp:

Mar 26, 2021 6:27:19 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

143520

Message:

/Config.kmk, /Makefile.kmk, Installer/win/Makefile.kmk: Start phasing out the .chm documentation including kchmviewer.

Location:

trunk

Files:

• Config.kmk (modified) (2 diffs)
• Makefile.kmk (modified) (2 diffs)
• src/VBox/Installer/win/Makefile.kmk (modified) (3 diffs)

trunk/Config.kmk

@@ -387 +387 @@
 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 = 1
+ VBOX_WITH_DOCS_CHM =
 endif
 # By default only include translations in documentation-only builds
@@ -722 +723 @@
 VBOX_WITH_ONLY_PYTHON_LIMITED_API = 1
 # Enable the kchmviewer.
-VBOX_WITH_KCHMVIEWER = 1
+## @todo CHM docs are on the way out...
+VBOX_WITH_KCHMVIEWER =
 # Build the Validation Kit.
 VBOX_WITH_VALIDATIONKIT = 1

trunk/Makefile.kmk

@@ -369 +369 @@
 buildserver-docs_SOURCES = \
         $(addprefix $(PATH_TARGET)/, \
-                VirtualBox.chm UserManual.pdf \
-                $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),VirtualBox_$(f).chm UserManual_$(f).pdf))
+                $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox.chm,) \
+                UserManual.pdf \
+                $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
+                        $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),VirtualBox_$(f).chm,) \
+                        UserManual_$(f).pdf))
 buildserver-docs_CLEANS = \
         $(buildserver-docs_0_OUTDIR)/unpacked.ts \
@@ -379 +382 @@
                 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),VirtualBox_$(f).chm UserManual_$(f).pdf))
 
-$$(buildserver-docs_0_OUTDIR)/unpacked.ts +| $(PATH_TARGET)/VirtualBox.chm $(PATH_TARGET)/UserManual.pdf \
+$$(buildserver-docs_0_OUTDIR)/unpacked.ts +| \
+        $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \
+        $(PATH_TARGET)/UserManual.pdf \
 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_TARGET)/VirtualBox_$(f).chm $(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 -- $(PATH_TARGET)/VirtualBox.chm \
+        $(TOUCH) -c -- \
+                $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox.chm,) \
                 $(PATH_TARGET)/UserManual.pdf \
-                $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_TARGET)/VirtualBox_$(f).chm $(PATH_TARGET)/UserManual_$(f).pdf)
+                $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES), \
+                        $(if-expr defined(VBOX_WITH_DOCS_CHM_PACKING),$(PATH_TARGET)/VirtualBox_$(f).chm,) \
+                        $(PATH_TARGET)/UserManual_$(f).pdf)
         $(APPEND) -t $@ "done"
 

trunk/src/VBox/Installer/win/Makefile.kmk

@@ -425 +425 @@
         #
 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"/>'
@@ -430 +431 @@
                      '  <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
+ 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"/>'
@@ -436 +437 @@
                      '  <Shortcut Id="sc_StartMenu_ManualPDF_$(lang)" Directory="dir_StartMenuVBox" Name="!(loc.StartMenu_UserManual) (PDF, $(VBOX_BRAND_$(lang)_LANG_NAME))"' \
                      '            Description="!(loc.StartMenu_UserManual) ($(VBOX_BRAND_$(lang)_LANG_NAME))" Target="[INSTALLDIR]\doc\UserManual_$(lang).pdf" WorkingDirectory="dir_Documents"/>')
+endif
         #
         # License(s) (RTF)