Changeset 76713 in vbox for trunk/doc

Timestamp:

Jan 8, 2019 4:41:40 PM (6 years ago)

Author:

vboxsync

Message:

doc/manual: When packaging, also include the zipped version of the HTML manual, it's nice to have for doing a release. Also adjust the cleaning to get rid of preface files (and fix the indentation there)

File:

• trunk/doc/manual/Makefile.kmk (modified) (5 diffs)

trunk/doc/manual/Makefile.kmk

@@ -137 +137 @@
  endif
 
+ ifdef VBOX_WITH_DOCS_HTML
+  INSTALLS += VBox-docs-usermanual-html
+  VBOX_PATH_BIN_HTML = $(PATH_STAGE_BIN)/UserManual-html.zip
+ else  # Do not build html.
+  VBOX_PATH_BIN_HTML =
+ endif
+
  ifdef VBOX_WITH_DOCS_CHM
   INSTALLS += VBox-docs-usermanual-chm
@@ -147 +154 @@
   VBOX_MANUAL_PACK += \
                 $(PATH_STAGE_BIN)/UserManual.pdf \
+                $(VBOX_PATH_BIN_HTML) \
                 $(VBOX_PATH_BIN_CHM)
   INSTALLS += VBox-docs-usermanual
@@ -249 +257 @@
         $(VBOX_XML_ENTITIES) \
         $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
-               $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
-               $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
-               isomakercmd-man.xml \
-               user_isomakercmd-man.xml \
-                $(VBOX_MANUAL_LATEX_FILES_TARGET) \
-                $(VBOX_MANUAL_PNG_FILES_$(lang)) \
-                $(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
-                $(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
-               html-single/UserManual.html \
-               $(addprefix HTMLHelp/,    index.html go01.html) \
-               $(addprefix html-chunks/, index.html go01.html) \
-               $(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
-                        ,html-chunks/ch$(n).html \
-                        html-chunks/re$(n).html \
-                        HTMLHelp/ch$(n).html \
-                        HTMLHelp/re$(n).html \
-                        $(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,HTMLHelp/ch$(n)s$(d2)$(d1).html)) ) \
-               $(foreach n,a b c \
-                        ,html-chunks/ap$(n).html \
-                        HTMLHelp/ap$(n).html \
-                $(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,HTMLHelp/ap$(n)s$(s).html) ) \
-               HTMLHelp/toc.hhc \
-               HTMLHelp/htmlhelp.hhp \
-                UserManual.pdf \
-                VirtualBox.chm \
-                ChangeLog.html \
-                validatemanual.run \
-                validateaccessibility.run \
-                validatesdkref.run \
-                )) \
+        $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
+        $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
+        isomakercmd-man.xml \
+        user_isomakercmd-man.xml \
+        $(VBOX_MANUAL_LATEX_FILES_TARGET) \
+        $(VBOX_MANUAL_PNG_FILES_$(lang)) \
+        $(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
+        $(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
+        html-single/UserManual.html \
+        $(addprefix HTMLHelp/,    index.html go01.html) \
+        $(addprefix html-chunks/, index.html go01.html) \
+        $(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
+            ,html-chunks/ch$(n).html \
+            html-chunks/re$(n).html \
+            HTMLHelp/ch$(n).html \
+            HTMLHelp/re$(n).html \
+            $(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,HTMLHelp/ch$(n)s$(d2)$(d1).html)) ) \
+        $(foreach n,a b c \
+            ,html-chunks/ap$(n).html \
+            HTMLHelp/ap$(n).html \
+            $(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,HTMLHelp/ap$(n)s$(s).html) ) \
+        $(foreach n,01 02 03 04 05 \
+            ,html-chunks/pr$(n).html \
+            HTMLHelp/pr$(n).html \
+            $(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) ) \
+        HTMLHelp/toc.hhc \
+        HTMLHelp/htmlhelp.hhp \
+        UserManual.pdf \
+        VirtualBox.chm \
+        ChangeLog.html \
+        validatemanual.run \
+        validateaccessibility.run \
+        validatesdkref.run \
+        )) \
         $(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
         $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
@@ -319 +331 @@
 VBox-docs-usermanual-l10n_MODE = a+r,u+w
 VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
+
+#
+# target for installing the chunked HTML docs
+#
+VBox-docs-usermanual-html_INST = $(INST_BIN)
+VBox-docs-usermanual-html_MODE = a+r,u+w
+VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
 
 #
@@ -747 +766 @@
  $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp)))
 
- # Packing the docs into a zip file
- $(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
+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 $@)
         $(QUIET)$(RM) -f $@
         $(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
-
-endif # VBOX_WITH_DOCS_CHM