Changeset 56155 in vbox

Timestamp:

May 29, 2015 2:39:36 PM (10 years ago)

Author:

vboxsync

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

100687

Message:

VBoxManage doc hacking just started...

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (1 diff)
• en_US/user_VBoxManage.xml (modified) (2 diffs)
• usage-to-docbook-manual.xsl (added)

trunk/doc/manual/Makefile.kmk

@@ -323 +323 @@
                 $(VBOX_PATH_MANUAL_OUTBASE)/% : \
                 $(VBOX_PATH_MANUAL_SRC)/% \
+                $(VBOX_PATH_MANUAL_SRC)/usage-to-docbook-manual.xsl \
                 $(VBOXMANAGEPATH) | $$(dir $$@)
         $(call MSG_L1,Pre-processing [2] $(@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,/\$$VBOX_MANAGE_OUTPUT/!d' \
-                       -e 's/\$$VBOX_MANAGE_OUTPUT.*//' \
-                       --output $@ [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,/\$$VBOX_MANAGE_OUTPUT/!d' \
+                -e 's/\$$VBOX_MANAGE_OUTPUT.*//' \
+                --output [email protected] [email protected]
         $(QUIET)$(REDIRECT) -wo [email protected] -E 'VBOX_LOG_FLAGS=disabled' -E 'VBOX_LOG_DEST=nofile' \
                 $(if $(eq $(KBUILD_TARGET),darwin), -E 'DYLD_FALLBACK_LIBRARY_PATH=$(dir $(LIB_RUNTIME))') \
                 -- \
                 $(VBOXMANAGEPATH) --dumpopts
-        $(QUIET)$(SED) -e 's/</\&lt;/g' -e 's/>/\&gt;/g' --append $@ [email protected]
-        $(QUIET)$(SED) -e '/\$$VBOX_MANAGE_OUTPUT/,$$!d' \
-                       -e 's/.*\$$VBOX_MANAGE_OUTPUT//' --append $@ [email protected]
-        $(QUIET)$(RM) -f [email protected] [email protected]
+        $(QUIET)$(SED) -e 's/</\&lt;/g' -e 's/>/\&gt;/g' --append [email protected] [email protected]
+        $(QUIET)$(SED) \
+                -e '/\$$VBOX_MANAGE_OUTPUT/,$$!d' \
+                -e 's/.*\$$VBOX_MANAGE_OUTPUT//' \
+                --append [email protected] [email protected]
+        $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet --output $@ \
+                $(VBOX_PATH_MANUAL_SRC)/usage-to-docbook-manual.xsl \
+                [email protected]
+        $(QUIET)$(RM) -f [email protected] [email protected] [email protected]
 
 VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+    user_VBoxManage.xml:
+      VBoxManage documentation for the user manual.
+
+      This XML document is also be used for generating the help text
+      built into VBoxManage as well as manpages (hacking in progress).
+
+    Copyright (C) 2006-2015 Oracle Corporation
+
+    This file is part of VirtualBox Open Source Edition (OSE), as
+    available from http://www.virtualbox.org. This file is free software;
+    you can redistribute it and/or modify it under the terms of the GNU
+    General Public License (GPL) as published by the Free Software
+    Foundation, in version 2 as it comes in the "COPYING" file of the
+    VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+    hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+
+ -->
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
@@ -7 +25 @@
   <sect1>
     <title>Introduction</title>
+    <brief>xxxx - not-Australia, right, mate?</brief>
 
     <para>As briefly mentioned in <xref linkend="frontends" />, VBoxManage is