[PATCH] libxl: document foreground '-F' option of create command

[PATCH] libxl: document foreground '-F' option of create command

[Giuseppe Mazzotta]

[-- Attachment #1: Type: text/plain, Size: 0 bytes --]



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: document-create-foreground-option.patch --]
[-- Type: text/x-patch; name="document-create-foreground-option.patch", Size: 1016 bytes --]

commit 482b29753946125bbcf892a5daa57b86620f68b1
Author: Giuseppe Mazzotta <g.mazzotta@iragan.com>
Date:   Fri Apr 17 17:10:03 2015 +0200

    libxl: document foreground '-F' option of create command
    
    Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>

diff --git a/tools/libxl/xl_cmdtable.c b/tools/libxl/xl_cmdtable.c
index 9284887..7f4759b 100644
--- a/tools/libxl/xl_cmdtable.c
+++ b/tools/libxl/xl_cmdtable.c
@@ -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"

[-- Attachment #3: Type: text/plain, Size: 126 bytes --]

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH] libxl: document foreground '-F' option of create command

[Ian Campbell]

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.

Re: [PATCH] libxl: document foreground '-F' option of create command

[Giuseppe Mazzotta]

On 04/22/2015 04:21 PM, Ian Campbell wrote:
> 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.
> 
Thanks. I will comply next time, sorry for the mishap.

> Do you fancy also adding -F to docs/man/xl.pod.1?
> 
Yes, I will follow-up in a few hours with another patch for that.

> Ian.
> 

--
  Giuseppe

[PATCH 1/2] libxl: reword command-line help text for -e and -F options of create subcommand

[Giuseppe Mazzotta]

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.

Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>
---
 tools/libxl/xl_cmdtable.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/libxl/xl_cmdtable.c b/tools/libxl/xl_cmdtable.c
index 7f4759b..804c3bf 100644
--- a/tools/libxl/xl_cmdtable.c
+++ b/tools/libxl/xl_cmdtable.c
@@ -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

[PATCH 2/2] docs/xl: document -e and -F options of create subcommand

[Giuseppe Mazzotta]

From: Giuseppe <g.mazzotta@iragan.com>

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'.

Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>
---
 docs/man/xl.pod.1 | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 16783c8..7bb26a6 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -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

[PATCH] docs/xl: document -F options of create subcommand

[Giuseppe Mazzotta]

From: Giuseppe <g.mazzotta@iragan.com>

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

Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>
---
 docs/man/xl.pod.1 | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 16783c8..02bf531 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -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

Re: [PATCH] libxl: document foreground '-F' option of create command

[Giuseppe Mazzotta]

On 04/22/2015 04:40 PM, Giuseppe Mazzotta wrote:
> On 04/22/2015 04:21 PM, Ian Campbell wrote:
>> On Fri, 2015-04-17 at 17:36 +0200, Giuseppe Mazzotta wrote:
>> Do you fancy also adding -F to docs/man/xl.pod.1?
>>
> Yes, I will follow-up in a few hours with another patch for that.
> 
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

[PATCH] Document '-F' option of create subcommand.

[Giuseppe Mazzotta]

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

Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>
---
 docs/man/xl.pod.1 | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 16783c8..02bf531 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -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

Re: [PATCH] Document '-F' option of create subcommand.

[Ian Campbell]

On Tue, 2015-05-12 at 14:51 +0000, Giuseppe Mazzotta wrote:
> Other options are still missing and not part of this patch.
> 
> Signed-off-by: Giuseppe Mazzotta <g.mazzotta@iragan.com>

Acked + applied, thanks.