VirtualBox

Changeset 77887 in vbox for trunk


Ignore:
Timestamp:
Mar 26, 2019 4:41:15 PM (6 years ago)
Author:
vboxsync
Message:

manual/VBoxManage: Made the new clonevm build. Again, there must be '=' between an option name and its value. The help-scope in the example section is not needed for commands without sub-commands. Use 'vmname|uuid' rather than just 'vm' as it's easier to grasp when just seeing the command synopsis.

Location:
trunk
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Config.kmk

    r77883 r77887  
    3737VBOX_MANUAL_XML_REFENTRY_FILES := \
    3838        man_VBoxManage-snapshot.xml \
     39        man_VBoxManage-clonevm.xml \
    3940        man_VBoxManage-mediumio.xml \
    4041        man_VBoxManage-debugvm.xml \

  • trunk/doc/manual/docbook-refentry-to-C-help.xsl

    r77882 r77887  
    246246      <xsl:choose>
    247247        <xsl:when test="parent::group"><xsl:value-of select="$arg.or.sep"/></xsl:when>
     248        <xsl:when test="parent::arg and self::group"></xsl:when>
    248249        <xsl:when test="ancestor-or-self::*/@sepchar"><xsl:value-of select="ancestor-or-self::*/@sepchar"/></xsl:when>
    249250        <xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
    … …  
    367368  <xsl:template match="varlistentry/listitem">
    368369    <xsl:call-template name="check-children">
    369       <xsl:with-param name="UnsupportedNodes" select="*[not(self::para or self::itemizedlist or self::orderedlist)]|text()"/>
     370      <xsl:with-param name="UnsupportedNodes" select="*[not(self::para or self::itemizedlist or self::orderedlist or self::variablelist)]|text()"/>
    370371      <xsl:with-param name="SupportedNames">para, itemizedlist and orderedlist</xsl:with-param>
    371372    </xsl:call-template>
    … …  
    911912  <xsl:template name="list-nodes">
    912913    <xsl:param name="Nodes" select="node()"/>
    913 
    914     <for-each select="$Nodes">
    915       <xsl:if test="posision() != 1">
     914    <xsl:for-each select="$Nodes">
     915      <xsl:if test="position() != 1">
    916916        <xsl:text>, </xsl:text>
    917917      </xsl:if>
    918918      <xsl:choose>
    919919        <xsl:when test="name(.) = ''">
    920           <xsl:text>text()</xsl:text>
     920          <xsl:text>text:text()</xsl:text>
    921921        </xsl:when>
    922922        <xsl:otherwise>
    … …  
    929929        </xsl:otherwise>
    930930      </xsl:choose>
    931     </for-each>
    932 
     931    </xsl:for-each>
    933932  </xsl:template>
    934933
    … …  
    944943        <!-- -->: error: Only <xsl:value-of select="$SupportedNames"/> are supported as children to <!-- -->
    945944        <xsl:value-of select="name($Node)"/>
    946         <!-- -->Unsupported children: <!-- -->
     945        <!-- -->
     946Unsupported children: <!-- -->
    947947        <xsl:call-template name="list-nodes">
    948948          <xsl:with-param name="Nodes" select="$UnsupportedNodes"/>

  • trunk/doc/manual/en_US/man_VBoxManage-clonevm.xml

    r77787 r77887  
    3939<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
    4040      <command>VBoxManage clonevm</command>
    41       <arg choice="plain"><replaceable>vm</replaceable></arg>
    42 
    43       <arg>--basefolder <replaceable>basefolder</replaceable></arg>
    44 
    45       <arg>--group <replaceable>group</replaceable>, ...</arg>
    46 
    47       <arg>--mode machine | machinechildren | all</arg>
    48 
    49       <arg>--name <replaceable>name</replaceable></arg>
    50 
    51       <arg>--options link | keepallmacs | keepnatmacs | keepdisknames | keephwuuids</arg>
     41      <arg choice="req"><replaceable>vmname|uuid</replaceable></arg>
     42
     43      <arg>--basefolder=<replaceable>basefolder</replaceable></arg>
     44
     45      <arg>--group=<replaceable>group</replaceable>, ...</arg>
     46
     47      <arg>--mode=<group choice='plain'><arg choice='plain'>machine</arg><arg choice='plain'>machinechildren</arg><arg choice='plain'>all</arg></group></arg>
     48
     49      <arg>--name=<replaceable>name</replaceable></arg>
     50
     51      <arg>--options=<group choice='plain'><arg choice='plain'>link</arg><arg choice='plain'>keepallmacs</arg><arg choice='plain'>keepnatmacs</arg><arg choice='plain'>keepdisknames</arg><arg choice='plain'>keephwuuids</arg></group></arg>
    5252
    5353      <arg>--register</arg>
    5454
    55       <arg>--snapshot <replaceable>snapshot-name</replaceable></arg>
    56 
    57       <arg>--uuid <replaceable>uuid</replaceable></arg>
     55      <arg>--snapshot=<replaceable>snapshot-name</replaceable></arg>
     56
     57      <arg>--uuid=<replaceable>uuid</replaceable></arg>
    5858    </cmdsynopsis>
    5959  </refsynopsisdiv>
    … …  
    8080    <variablelist>
    8181      <varlistentry>
    82         <term><replaceable>vm</replaceable></term>
     82        <term><replaceable>vmname|uuid</replaceable></term>
    8383        <listitem><para>
    8484            Specifies the name or UUID of the VM to clone.
    … …  
    8686      </varlistentry>
    8787      <varlistentry>
    88         <term><option>--basefolder <replaceable>basefolder</replaceable></option></term>
     88        <term><option>--basefolder=<replaceable>basefolder</replaceable></option></term>
    8989        <listitem><para>
    9090            Specifies the name of the folder in which to save the
    … …  
    9393      </varlistentry>
    9494      <varlistentry>
    95         <term><option>--groups <replaceable>group</replaceable>, ...</option></term>
     95        <term><option>--groups=<replaceable>group</replaceable>, ...</option></term>
    9696        <listitem><para>
    9797            Assigns the clone to the specified group or groups. If you
    … …  
    107107      </varlistentry>
    108108      <varlistentry>
    109         <term><option>--mode machine|machineandchildren|all</option></term>
     109        <term><option>--mode=machine|machineandchildren|all</option></term>
    110110        <listitem><para>
    111111            Specifies which of the following cloning modes to use:
    … …  
    129129      </varlistentry>
    130130      <varlistentry>
    131         <term><option>--name <replaceable>name</replaceable></option></term>
     131        <term><option>--name=<replaceable>name</replaceable></option></term>
    132132        <listitem><para>
    133133            Specifies a new name for the new VM. The default value is
    … …  
    139139      </varlistentry>
    140140      <varlistentry>
    141         <term><option>--options</option></term>
     141        <term><option>--options=option</option></term>
    142142        <listitem><para>
    143143            Specifies how to create a new clone.
    144144          </para><variablelist>
    145145            <varlistentry>
    146               <term><option>--options link</option></term>
     146              <term><option>--options=link</option></term>
    147147              <listitem><para>
    148148                  Creates a linked clone from a snapshot only.
    … …  
    150150            </varlistentry>
    151151            <varlistentry>
    152               <term><option>--options keepallmacs</option></term>
     152              <term><option>--options=keepallmacs</option></term>
    153153              <listitem><para>
    154154                  Specifies that the new clone reuses the MAC addresses
    … …  
    156156                </para><para>
    157157                  If you do not specify this option or the
    158                   <option>--options keepnatmacs</option> option, the
     158                  <option>--options=keepnatmacs</option> option, the
    159159                  default behavior is to reinitialize the MAC addresses
    160160                  of each virtual network card.
    … …  
    162162            </varlistentry>
    163163            <varlistentry>
    164               <term><option>--options keepnatmacs</option></term>
     164              <term><option>--options=keepnatmacs</option></term>
    165165              <listitem><para>
    166166                  Specifies that the new clone reuses the MAC addresses
    … …  
    169169                </para><para>
    170170                  If you do not specify this option or the
    171                   <option>--options keepallmacs</option> option, the
     171                  <option>--options=keepallmacs</option> option, the
    172172                  default behavior is to reinitialize the MAC addresses
    173173                  of each virtual network card.
    … …  
    175175            </varlistentry>
    176176            <varlistentry>
    177               <term><option>--option keepdisknames</option></term>
     177              <term><option>--option=keepdisknames</option></term>
    178178              <listitem><para>
    179179                  Specifies that the new clone reuses the disk image
    … …  
    183183            </varlistentry>
    184184            <varlistentry>
    185               <term><option>--option keephwuuids</option></term>
     185              <term><option>--option=keephwuuids</option></term>
    186186              <listitem><para>
    187187                  Specifies that the new clone reuses the hardware IDs
    … …  
    201201      </varlistentry>
    202202      <varlistentry>
    203         <term><option>--snapshot <replaceable>snapshot-name</replaceable></option></term>
     203        <term><option>--snapshot=<replaceable>snapshot-name</replaceable></option></term>
    204204        <listitem><para>
    205205            Specifies the snapshot on which to base the new VM. By
    … …  
    209209      </varlistentry>
    210210      <varlistentry>
    211         <term><option>--uuid <replaceable>uuid</replaceable></option></term>
     211        <term><option>--uuid=<replaceable>uuid</replaceable></option></term>
    212212        <listitem><para>
    213213            Specifies the UUID for the new VM. Ensure that this ID is
    … …  
    222222  <refsect1>
    223223    <title>Examples</title>
    224     <remark role="help-scope"/>
    225224    <para>
    226225      The following command creates and registers an exact clone of the
    … …  
    234233    </para>
    235234<screen>
    236 $ VBoxManage clonevm ol7 --name "ol7-dev-001" --register --mode all \
    237 --options keepallmacs --options keepdisknames --options keephwuuids
     235$ VBoxManage clonevm ol7 --name="ol7-dev-001" --register --mode=all \
     236    --options=keepallmacs --options=keepdisknames --options=keephwuuids
    238237</screen>
    239238    <para>
    … …  
    244243    </para>
    245244<screen>
    246 $ VBoxManage clonevm ol7 --name "ol7-dev-002" --register --snapshot "Snapshot 1"
     245$ VBoxManage clonevm ol7 --name="ol7-dev-002" --register --snapshot="Snapshot 1"
    247246</screen>
    248247  </refsect1>

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

    r77883 r77887  
    103103    { "registervm",         USAGE_REGISTERVM,       VBMG_CMD_TODO, handleRegisterVM,           0 },
    104104    { "unregistervm",       USAGE_UNREGISTERVM,     VBMG_CMD_TODO, handleUnregisterVM,         0 },
    105     { "clonevm",            USAGE_CLONEVM,          VBMG_CMD_TODO, handleCloneVM,              0 },
     105    { "clonevm",            USAGE_S_NEWCMD,      HELP_CMD_CLONEVM, handleCloneVM,              0 },
    106106    { "movevm",             USAGE_MOVEVM,           VBMG_CMD_TODO, handleMoveVM,               0 },
    107107    { "mediumproperty",     USAGE_MEDIUMPROPERTY,   VBMG_CMD_TODO, handleMediumProperty,       0 },

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

    r77883 r77887  
    5757    USAGE_CREATEVM,
    5858    USAGE_MODIFYVM,
    59     USAGE_CLONEVM,
    6059    USAGE_STARTVM,
    6160    USAGE_CONTROLVM,

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

    r77801 r77887  
    733733                     "\n");
    734734    }
    735 
    736     if (enmCommand == USAGE_CLONEVM || enmCommand == USAGE_S_ALL)
    737         RTStrmPrintf(pStrm,
    738                            "%s clonevm %s         <uuid|vmname>\n"
    739                      "                            [--snapshot <uuid>|<name>]\n"
    740                      "                            [--mode machine|machineandchildren|all]\n"
    741                      "                            [--options link|keepallmacs|keepnatmacs|\n"
    742                      "                                       keepdisknames|keephwuuids]\n"
    743                      "                            [--name <name>]\n"
    744                      "                            [--groups <group>, ...]\n"
    745                      "                            [--basefolder <basefolder>]\n"
    746                      "                            [--uuid <uuid>]\n"
    747                      "                            [--register]\n"
    748                      "\n", SEP);
    749735
    750736    if (enmCommand == USAGE_MOVEVM || enmCommand == USAGE_S_ALL)

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageMisc.cpp

    r77877 r77887  
    541541                    pszSrcName = ValueUnion.psz;
    542542                else
    543                     return errorSyntax(USAGE_CLONEVM, "Invalid parameter '%s'", ValueUnion.psz);
     543                    return errorSyntax("Invalid parameter '%s'", ValueUnion.psz);
    544544                break;
    545545
    546546            default:
    547                 return errorGetOpt(USAGE_CLONEVM, c, &ValueUnion);
     547                return errorGetOpt(c, &ValueUnion);
    548548        }
    549549    }
    … …  
    551551    /* Check for required options */
    552552    if (!pszSrcName)
    553         return errorSyntax(USAGE_CLONEVM, "VM name required");
     553        return errorSyntax("VM name required");
    554554
    555555    /* Get the machine object */
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette