Changeset 56542 in vbox for trunk/doc

Timestamp:

Jun 18, 2015 8:08:45 PM (9 years ago)

Author:

vboxsync

Message:

Use xi:include instead of SED for including user_ChangeLogImpl.xml into user_ChangeLog.xml.

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (14 diffs)
• en_US/user_ChangeLog.xml (modified) (1 diff)
• user_ChangeLogImpl.xml (modified) (2 diffs)

trunk/doc/manual/Makefile.kmk

@@ -426 +426 @@
 #       $(QUIET)$(INSTALL) -m 0644 $< $@
 
+# Manual dependency on user_ChangeLogImpl.xml
+$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
+,$(eval $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_ChangeLog.xml: $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml))
+
 # intermediate step to do some variable replacement in the document
-$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(filter-out user_VBoxManage.xml,$(VBOX_MANUAL_XML_FILES)))): \
+$(foreach f,$(VBOX_MANUAL_LANGUAGES) \
+,$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(filter-out user_VBoxManage.xml,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)))): \
                 $(VBOX_PATH_MANUAL_OUTBASE)/% : $(VBOX_PATH_MANUAL_SRC)/% $(VBOX_VERSION_STAMP) | $$(dir $$@)
         $(call MSG_L1,Pre-processing [1] $(@F) to $@)
@@ -438 +443 @@
                        -e 's/@VBOX_PRODUCT@/$(VBOX_PRODUCT)/g' \
                        -e 's/@VBOX_C_YEAR@/$(VBOX_C_YEAR)/g' \
+                       -e 's|@VBOX_PATH_MANUAL_SRC@|$(VBOX_PATH_MANUAL_SRC)|g' \
                        --output [email protected] $<
         $(QUIET)$(MV) -f [email protected] $@
-
-$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_ChangeLog.xml): \
-                $(VBOX_PATH_MANUAL_OUTBASE)/% : \
-                $(VBOX_PATH_MANUAL_SRC)/% $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml | $$(dir $$@)
-        $(call MSG_L1,Pre-processing [3] $(@F) to $@)
-        $(QUIET)$(RM) -f $@ [email protected] [email protected]
-        $(QUIET)$(SED) -e 's/@VBOX_VERSION_MAJOR@/$(VBOX_VERSION_MAJOR)/g' \
-                       -e 's/@VBOX_VERSION_MINOR@/$(VBOX_VERSION_MINOR)/g' \
-                       -e 's/@VBOX_VERSION_BUILD@/$(VBOX_VERSION_BUILD)/g' \
-                       -e 's/@VBOX_VERSION_STRING@/$(VBOX_VERSION_STRING)/g' \
-                       -e 's/@VBOX_VENDOR@/$(VBOX_VENDOR)/g' \
-                       -e 's/@VBOX_PRODUCT@/$(VBOX_PRODUCT)/g' \
-                       -e 's/@VBOX_C_YEAR@/$(VBOX_C_YEAR)/g' \
-                       --output [email protected] $<
-        $(QUIET)$(SED) -e '1,/<!--@VIRTUALBOX_CHANGELOG_IMPL@-->/!d' \
-                       -e 's/<!--@VIRTUALBOX_CHANGELOG_IMPL@-->//' \
-                       --output $@ [email protected]
-        var=`$(SED) -n '/!--@VIRTUALBOX_CHANGELOG_IMPL@-->/p' $<`; \
-                test -n "$${var}" \
-                && $(SED) -e 's/<?xml version=\"1.0\" encoding=\"UTF-8\"?>//g' \
-                        --append $@ $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml; \
-        true
-        $(QUIET)$(SED) -e '/<!--@VIRTUALBOX_CHANGELOG_IMPL@-->/,$$!d' \
-                       -e 's/<!--@VIRTUALBOX_CHANGELOG_IMPL@-->//' --append $@ [email protected]
-        $(QUIET)$(RM) -f -- "[email protected]"
 
 # TODO: figure why the rule below doesn't cause kmk to rebuild the manual when a man page changes!
@@ -524 +505 @@
                 $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                 $$(VBOX_VERSION_STAMP) | $$(dir $$@)
-        $$(call MSG_GENERATE,,$$@,$$<)
+        $$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
         $$(QUIET)$$(RM) -f "$$@"
         $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
@@ -539 +520 @@
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                | $$(dir $$@)
-        $(call MSG_GENERATE,,$@,$(filter %.xml,$^))
+        $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
 
@@ -624 +605 @@
                 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/%/validatemanual.run,) \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT)
-        $(call MSG_L1,Generating $@ from DocBook XML)
+        $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(RM) -f $(addprefix $(@D)/,$(VBOX_MANUAL_LATEX_FILES_TARGET))
 #   generate TeX source from processed docbook and store it in UserManual.tex.tmp;
@@ -709 +690 @@
                 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT) | $$(dir $$@)
-        $(call MSG_L1,Generating $@ from DocBook XML)
+        $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
 #       generate TeX source from processed docbook and store it in SDKRef.tex.tmp
@@ -794 +775 @@
                 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/%/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK)
-        $(call MSG_L1,xsltproc $<,=> $@)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(RM) -f $@
         $(QUIET)$(MKDIR) -p $(@D)
@@ -845 +826 @@
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                 | $$(dir $$@)
-        $(call MSG_L1,xsltproc $<)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) \
                 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
@@ -858 +839 @@
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                 | $$(dir $$@)
-        $(call MSG_L1,xsltproc $<)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) \
                 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
@@ -891 +872 @@
                 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) | $$(dir $$@)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
         $(call MSG_L1,Fresh ChangeLog.html is now at $@)
@@ -918 +900 @@
                 $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
-        $$(call MSG_GENERATE,,$$@,$$<)
+        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
         $$(QUIET)$$(RM) -f "$$@"
         $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ \
@@ -931 +913 @@
                 $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
                 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
-        $$(call MSG_GENERATE,,$$@,$$<)
+        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
         $$(QUIET)$$(RM) -f "$$@"
         $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-manpage.xsl $$<
@@ -968 +950 @@
                 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
-        $(call MSG_GENERATE,,$@,$<)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(filter %.xml,$^),$@)
         $(QUIET)$(APPEND) -tn "$@" \
                 '/* Autogenerated by $<, do not edit! */' \
@@ -991 +973 @@
                 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
-        $(call MSG_GENERATE,,$@,$<)
+        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(filter %.xml,$^),$@)
         $(QUIET)$(APPEND) -tn "$@" \
                 '/* Autogenerated by $<, do not edit! */' \

trunk/doc/manual/en_US/user_ChangeLog.xml

@@ -14 +14 @@
   In addition, each build contains a revision number.</para>
 
-<!--@VIRTUALBOX_CHANGELOG_IMPL@-->
+  <xi:include href="@VBOX_PATH_MANUAL_SRC@/user_ChangeLogImpl.xml" xpointer="xpointer(/chapter/*)"
+    xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <sect1>

trunk/doc/manual/user_ChangeLogImpl.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
+<chapter> <!-- HACK ALERT! Seems we must have a single top level element for xi:include to work.
+                           So, we use chapter and xpointer="xpointer(/chapter/)" with xi:include. -->
   <sect1>
     <title>Version 5.0.0 Release Candidate 1 (2015-06-01)</title>
@@ -12424 +12426 @@
 
   </sect1>
-
+</chapter>
+