Changeset 77791 in vbox for trunk/doc

Timestamp:

Mar 19, 2019 3:38:54 PM (6 years ago)

Author:

vboxsync

Message:

manual/man_VBoxManage-snapshot.xml: there must be an '=' between option name and <replaceable>, both for consistency and because the --help generate is unable to insert any space there, so it will become unreable/misleading.

File:

• trunk/doc/manual/en_US/man_VBoxManage-snapshot.xml (modified) (7 diffs)

trunk/doc/manual/en_US/man_VBoxManage-snapshot.xml

@@ -50 +50 @@
       <arg choice="plain"><replaceable>snapshot-name</replaceable></arg>
 
-      <arg>--description <replaceable>description</replaceable></arg>
+      <arg>--description=<replaceable>description</replaceable></arg>
 
       <arg>--live</arg>
@@ -90 +90 @@
       <arg choice="plain"><replaceable>snapshot-name</replaceable> | --current</arg>
 
-      <arg>--description <replaceable>description</replaceable></arg>
-
-      <arg>--name <replaceable>new-name</replaceable></arg>
+      <arg>--description=<replaceable>description</replaceable></arg>
+
+      <arg>--name=<replaceable>new-name</replaceable></arg>
     </cmdsynopsis>
 
@@ -167 +167 @@
       <variablelist>
         <varlistentry>
-          <term><option>--description <replaceable>description</replaceable></option></term>
+          <term><option>--description=<replaceable>description</replaceable></option></term>
           <listitem><para>
               Specifies a description of the snapshot.
@@ -273 +273 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--description <replaceable>description</replaceable></option></term>
+          <term><option>--description=<replaceable>description</replaceable></option></term>
           <listitem><para>
               Specifies a new description for the snapshot.
@@ -279 +279 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--name <replaceable>new-name</replaceable></option></term>
+          <term><option>--name=<replaceable>new-name</replaceable></option></term>
           <listitem><para>
               Specifies a new name for the snapshot.
@@ -358 +358 @@
 <screen>
 $ VBoxManage snapshot ol7u4 take ol7u4-snap-001 \
---description "Oracle Linux 7.4"
+--description="Oracle Linux 7.4"
 </screen>
     <para>
@@ -374 +374 @@
 <screen>
 $ VBoxManage snapshot ol7u4 edit ol7u4-snap-001 \
---description "Oracle Linux 7.4 with UEK4 kernel"
+--description="Oracle Linux 7.4 with UEK4 kernel"
 </screen>
     <para>