libxl: document foreground '-F' option of create command

commit 482b29753946125bbcf892a5daa57b86620f68b1

Author: Giuseppe Mazzotta <[email protected]>
Date:   Fri Apr 17 17:10:03 2015 +0200

libxl: document foreground '-F' option of create command

index 9284887..7f4759b 100644
@@ -30,6 +30,7 @@ struct cmd_spec cmd_table[] = {
       "-n, --dryrun            Dry run - prints the resulting configuration\n"
       "                         (deprecated in favour of global -N option).\n"
       "-d                      Enable debug messages.\n"
+      "-F                      Run in foreground until death of the domain.\n"
       "-e                      Do not wait in the background for the death of the domain.\n"
       "-V, --vncviewer         Connect to the VNC display after the domain is created.\n"
       "-A, --vncviewer-autopass\n"

_______________________________________________
Xen-devel mailing list
[email protected]
http://lists.xen.org/xen-devel

On Fri, 2015-04-17 at 17:36 +0200, Giuseppe Mazzotta wrote:

Acked + applied.

For next time please use git send-email or git format-patch so that your mail can be fed to git am directly, I did it by hand this time.

Do you fancy also adding -F to docs/man/xl.pod.1?

Ian.

Thanks. I will comply next time, sorry for the mishap.

Yes, I will follow-up in a few hours with another patch for that.

--
Giuseppe

Use a better wording about what the -e and -F options do; this is evident by looking at main_create(), as the only difference is the setting of 'monitor' variable. The help text for '-e' was possibly a copy-paste artifact.

---
 tools/libxl/xl_cmdtable.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

index 7f4759b..804c3bf 100644
@@ -30,8 +30,8 @@ struct cmd_spec cmd_table[] = {
       "-n, --dryrun            Dry run - prints the resulting configuration\n"
       "                         (deprecated in favour of global -N option).\n"
       "-d                      Enable debug messages.\n"
-      "-F                      Run in foreground until death of the domain.\n"
-      "-e                      Do not wait in the background for the death of the domain.\n"
+      "-e                      Run in foreground until death of the domain.\n"
+      "-F                      Same as -e, with additional guest monitoring messages.\n"
       "-V, --vncviewer         Connect to the VNC display after the domain is created.\n"
       "-A, --vncviewer-autopass\n"
       "                        Pass VNC password to viewer via stdin."

1.9.1

From: Giuseppe <[email protected]>

While documenting '-F' option, I discovered that not only '-e' was missing (and hereby added with this patch) but others too. I will eventually submit other patches for the remaining missing options, as this one focuses only on '-e' and '-F'.

---
 docs/man/xl.pod.1 | 11 +++++++++++
 1 file changed, 11 insertions(+)

index 16783c8..7bb26a6 100644
@@ -115,6 +115,9 @@ Create will return B<as soon> as the domain is started.  This B<does
 not> mean the guest OS in the domain has actually booted, or is
 available for input.
 
+If the I<-F> or I<-e> option is specified, create will start the domain and
+not return until its death.
+
 B<OPTIONS>
 
 =over 4 

@@ -131,6 +134,14 @@ Use the given configuration file.
 
 Leave the domain paused after it is created.
 
+=item B<-e>
+
+Run in foreground until death of the domain.
+
+=item B<-F>
+
+Same as I<-e>, with additional guest monitoring messages.
+
 =item B<-V>, B<--vncviewer>
 
 Attach to domain's VNC server, forking a vncviewer process.

1.9.1

From: Giuseppe <[email protected]>

Document '-F' option. Other options are still missing and not in this patch.

---
 docs/man/xl.pod.1 | 7 +++++++
 1 file changed, 7 insertions(+)

index 16783c8..02bf531 100644
@@ -115,6 +115,9 @@ Create will return B<as soon> as the domain is started.  This B<does
 not> mean the guest OS in the domain has actually booted, or is
 available for input.
 
+If the I<-F> option is specified, create will start the domain and not
+return until its death.
+
 B<OPTIONS>
 
 =over 4 

@@ -131,6 +134,10 @@ Use the given configuration file.
 
 Leave the domain paused after it is created.
 
+=item B<-F>
+
+Run in foreground until death of the domain.
+
 =item B<-V>, B<--vncviewer>
 
 Attach to domain's VNC server, forking a vncviewer process.

1.9.1

Please disregard my 2-patches set trying to document -e and -F, sorry for the noise. I will refrain from submitting doc updates for the other missing options (there's more, apparently) until I better understand how they work.

The latest one is the patch I propose for now:
http://lists.xen.org/archives/html/xen-devel/2015-04/msg02606.html

Kind regards,
--
Giuseppe

Other options are still missing and not part of this patch.

---
 docs/man/xl.pod.1 | 7 +++++++
 1 file changed, 7 insertions(+)

index 16783c8..02bf531 100644
@@ -115,6 +115,9 @@ Create will return B<as soon> as the domain is started.  This B<does
 not> mean the guest OS in the domain has actually booted, or is
 available for input.
 
+If the I<-F> option is specified, create will start the domain and not
+return until its death.
+
 B<OPTIONS>
 
 =over 4 

@@ -131,6 +134,10 @@ Use the given configuration file.
 
 Leave the domain paused after it is created.
 
+=item B<-F>
+
+Run in foreground until death of the domain.
+
 =item B<-V>, B<--vncviewer>
 
 Attach to domain's VNC server, forking a vncviewer process.

1.9.1

Acked + applied, thanks.