[vbox-dev] [PATCH] Remove --wait-exit from documentation
Andy Pont
andy.pont at sdcsystems.com
Tue May 8 14:21:45 UTC 2018
The documentation (English US and French) references a --wait-exit option for "VBoxManage guestcontrol" but there is no corresponding option in the source code and the command returns "VBoxManage.exe: error: Unknown option: --wait-exit".
This was reported in the forums earlier today (8th May 2018): https://forums.virtualbox.org/viewtopic.php?f=6&t=87888
This patch removes the options from the documentation to avoid confusion.
Index: doc/manual/en_US/user_VBoxManage.xml
===================================================================
--- doc/manual/en_US/user_VBoxManage.xml (revision 72142)
+++ doc/manual/en_US/user_VBoxManage.xml (working copy)
@@ -4549,8 +4549,8 @@
applications; please see <xref linkend="KnownIssues" /> for more
information.</para>
</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
+ --username foo --passwordfile bar.txt --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe"
+ --username foo --passwordfile bar.txt --wait-stdout</screen> Note that
the double backslashes in the second example are only required on
Unix hosts.</para>
@@ -4663,8 +4663,8 @@
applications; please see <xref linkend="KnownIssues" /> for more
information.</para>
</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
+ --username foo --passwordfile bar.txt --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe"
+ --username foo --passwordfile bar.txt --wait-stdout</screen> Note that
the double backslashes in the second example are only required on
Unix hosts.</para>
Index: doc/manual/fr_FR/user_VBoxManage.xml
===================================================================
--- doc/manual/fr_FR/user_VBoxManage.xml (revision 72142)
+++ doc/manual/fr_FR/user_VBoxManage.xml (working copy)
@@ -2830,7 +2830,7 @@
[--passwordfile <fichier> | --password <mot de passe>]
[--environment "<NOM>=<VALEUR> [<NOM>=<VALEUR>]"]
[--verbose] [--timeout <msec>]
- [--wait-exit] [--wait-stdout] [--wait-stderr]
+ [--wait-stdout] [--wait-stderr]
[--dos2unix] [--unix2dos]
-- [[<argument1>] ... [<argumentN>]]</screen>
@@ -2946,15 +2946,6 @@
</glossentry>
<glossentry>
- <glossterm><computeroutput>--wait-exit</computeroutput></glossterm>
-
- <glossdef>
- <para>Attend la fin d'un processus et affiche son code de
- sortie avec la raison/les drapeaux de sa fin.</para>
- </glossdef>
- </glossentry>
-
- <glossentry>
<glossterm><computeroutput>--wait-stdout</computeroutput></glossterm>
<glossdef>
@@ -2991,8 +2982,8 @@
graphiques ; merci de voir <xref linkend="KnownIssues" /> pour
plus d'informations.</para>
</note> Exemples : <screen>VBoxManage --nologo guestcontrol "Ma VM" execute --image "/bin/ls"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe"
- --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Remarquez que
+ --username foo --passwordfile bar.txt --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe"
+ --username foo --passwordfile bar.txt --wait-stdout</screen> Remarquez que
les deux barres obliques inversées du deuxième exemple ne sont requis
que pour les hôtes Unix.</para>
More information about the vbox-dev
mailing list