Changeset 56192 in vbox

Timestamp:

Jun 1, 2015 3:46:50 PM (10 years ago)

Author:

vboxsync

Message:

Extract the necessary bits for the VBoxManage Commands Overview section from the refentry file(s).

Location:

trunk

Files:

• doc/manual/Makefile.kmk (modified) (3 diffs)
• doc/manual/docbook-refentry-to-manual-overview.xsl (added)
• doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (2 diffs)

trunk/doc/manual/Makefile.kmk

@@ -453 +453 @@
 $(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
 $(eval $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_VBoxManage.xml: $(VBOX_PATH_MANUAL_SRC)/$(lang)/user_VBoxManage.xml \
-        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES)))))
+        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
+        $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml ))
 
 # user_VBoxManage.xml currently needs some extra processing to stitch in the VBoxManage usage blob.
@@ -460 +461 @@
                 $(VBOX_PATH_MANUAL_SRC)/% \
                $$(addprefix $$(@D)/,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
+                $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
                 $(VBOX_XML_CATALOG) \
                 $(VBOX_XML_CATALOG_DOCBOOK) \
@@ -516 +518 @@
                --output $@ $<
 
+# Generates the VBoxManage command overview include file (shared between
+# languages) from the refsynopsisdiv section of the man pages.
+$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml: \
+                $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(filter man_VBoxManage_%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
+               | $$(dir $$@)
+        $(call MSG_GENERATE,,$@,en_US/man_VBoxManage_*.xml)
+        $(QUIET)$(RM) -f -- "$@"
+        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet --output "$@" \
+                $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(filter man_VBoxManage_%,$(VBOX_MANUAL_XML_REFENTRY_FILES)))
+
+xxxx:: $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml
+
 # generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
 $(VBOX_MANUAL_APIREF_TMP): $(VBOX_DOC_XIDL_SRC_TMP) $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -160 +160 @@
 
     <screen>$VBOX_MANAGE_OUTPUT</screen>
+    <xi:include href="../user_VBoxManage_CommandsOverview.xml" xpointer="element(/1)"
+      xmlns:xi="http://www.w3.org/2001/XInclude" />
 
     <para>Each time VBoxManage is invoked, only one command can be executed.

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

@@ -868 +868 @@
                      "\n", SEP, SEP);
     }
+#ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
     if (fCategory & USAGE_EXTPACK)
     {
@@ -876 +877 @@
                      "\n", SEP);
     }
+#endif
 }